From 22c71a4e5b8bf0a816bd6d9cdefeb68e7f85ffdc Mon Sep 17 00:00:00 2001 From: Arnau Casau <47946624+arnaucasau@users.noreply.github.com> Date: Fri, 3 May 2024 14:57:34 +0200 Subject: [PATCH] Remove signature for the Attribute component (#1291) This PR removes the signature prop from the Attribute component and instead, sets `attributeTypeHint` and `attributeValue`. This change simplifies the script that was using different props for attributes embedded in the class page and the rest. As a side effect, this PR also fixes an issue with some default values not showing correctly. These values were treated as signatures and wrongly converted into HTML by a unified plugin. Closes #1217 #1252 --- .../0.7/qiskit_ibm_provider.IBMBackend.mdx | 24 +++---- .../0.7/qiskit_ibm_provider.IBMProvider.mdx | 4 +- .../0.7/qiskit_ibm_provider.Session.mdx | 4 +- .../qiskit_ibm_provider.job.IBMCircuitJob.mdx | 6 +- ...iskit_ibm_provider.job.IBMCompositeJob.mdx | 4 +- .../0.7/qiskit_ibm_provider.job.QueueInfo.mdx | 4 +- ...ing.DynamicCircuitInstructionDurations.mdx | 4 +- .../0.19/qiskit.aqua.QuantumInstance.mdx | 2 +- ...it.aqua.algorithms.AmplitudeEstimation.mdx | 4 +- ...skit.aqua.algorithms.BernsteinVazirani.mdx | 4 +- .../qiskit.aqua.algorithms.DeutschJozsa.mdx | 4 +- .../0.19/qiskit.aqua.algorithms.EOH.mdx | 4 +- .../0.19/qiskit.aqua.algorithms.Grover.mdx | 4 +- .../0.19/qiskit.aqua.algorithms.HHL.mdx | 4 +- .../0.19/qiskit.aqua.algorithms.IQPE.mdx | 8 +-- ...lgorithms.IterativeAmplitudeEstimation.mdx | 6 +- ...s.MaximumLikelihoodAmplitudeEstimation.mdx | 4 +- ...kit.aqua.algorithms.MinimumEigensolver.mdx | 4 +- ...ua.algorithms.MinimumEigensolverResult.mdx | 6 +- ...iskit.aqua.algorithms.NumPyEigensolver.mdx | 6 +- ...qua.algorithms.NumPyMinimumEigensolver.mdx | 4 +- .../0.19/qiskit.aqua.algorithms.QAOA.mdx | 18 +++--- .../0.19/qiskit.aqua.algorithms.QGAN.mdx | 4 +- .../0.19/qiskit.aqua.algorithms.QPE.mdx | 8 +-- .../0.19/qiskit.aqua.algorithms.QSVM.mdx | 6 +- ...iskit.aqua.algorithms.QuantumAlgorithm.mdx | 4 +- .../0.19/qiskit.aqua.algorithms.Shor.mdx | 4 +- .../0.19/qiskit.aqua.algorithms.Simon.mdx | 4 +- .../0.19/qiskit.aqua.algorithms.VQC.mdx | 12 ++-- .../0.19/qiskit.aqua.algorithms.VQE.mdx | 18 +++--- .../qiskit.aqua.components.oracles.Oracle.mdx | 6 +- .../qiskit.aqua.operators.OperatorBase.mdx | 2 +- ...ua.operators.converters.CircuitSampler.mdx | 4 +- ....operators.converters.PauliBasisChange.mdx | 2 +- ...it.aqua.operators.evolutions.EvolvedOp.mdx | 6 +- ...ators.evolutions.PauliTrotterEvolution.mdx | 2 +- ...iskit.aqua.operators.evolutions.QDrift.mdx | 2 +- ...iskit.aqua.operators.evolutions.Suzuki.mdx | 4 +- ...skit.aqua.operators.evolutions.Trotter.mdx | 4 +- ...perators.evolutions.TrotterizationBase.mdx | 2 +- ...ua.operators.legacy.LegacyBaseOperator.mdx | 2 +- ...kit.aqua.operators.list_ops.ComposedOp.mdx | 12 ++-- .../qiskit.aqua.operators.list_ops.ListOp.mdx | 12 ++-- ...iskit.aqua.operators.list_ops.SummedOp.mdx | 12 ++-- ...kit.aqua.operators.list_ops.TensoredOp.mdx | 12 ++-- ...aqua.operators.primitive_ops.CircuitOp.mdx | 6 +- ....aqua.operators.primitive_ops.MatrixOp.mdx | 6 +- ...t.aqua.operators.primitive_ops.PauliOp.mdx | 6 +- ...ua.operators.primitive_ops.PrimitiveOp.mdx | 6 +- ...qua.operators.state_fns.CircuitStateFn.mdx | 6 +- ...t.aqua.operators.state_fns.DictStateFn.mdx | 6 +- ...ua.operators.state_fns.OperatorStateFn.mdx | 6 +- ...iskit.aqua.operators.state_fns.StateFn.mdx | 6 +- ...aqua.operators.state_fns.VectorStateFn.mdx | 6 +- .../0.19/qiskit.chemistry.QMolecule.mdx | 10 +-- .../qiskit.chemistry.algorithms.QEomEE.mdx | 4 +- .../qiskit.chemistry.algorithms.QEomVQE.mdx | 18 +++--- .../qiskit.chemistry.algorithms.VQEAdapt.mdx | 10 +-- ...iskit.chemistry.core.ChemistryOperator.mdx | 8 +-- .../qiskit.chemistry.core.Hamiltonian.mdx | 8 +-- ...hemistry.core.MolecularChemistryResult.mdx | 8 +-- ...stry.core.MolecularExcitedStatesResult.mdx | 10 +-- ...mistry.core.MolecularGroundStateResult.mdx | 46 +++++++------- ...qiskit.chemistry.core.QubitMappingType.mdx | 6 +- ...skit.chemistry.core.TransformationType.mdx | 4 +- .../0.19/qiskit.circuit.ClassicalRegister.mdx | 4 +- .../0.19/qiskit.circuit.ControlledGate.mdx | 6 +- docs/api/qiskit/0.19/qiskit.circuit.Gate.mdx | 2 +- .../0.19/qiskit.circuit.QuantumCircuit.mdx | 8 +-- .../0.19/qiskit.circuit.QuantumRegister.mdx | 4 +- .../0.19/qiskit.circuit.library.AND.mdx | 8 +-- .../0.19/qiskit.circuit.library.C3XGate.mdx | 6 +- .../0.19/qiskit.circuit.library.C4XGate.mdx | 6 +- .../0.19/qiskit.circuit.library.CCXGate.mdx | 6 +- .../0.19/qiskit.circuit.library.CHGate.mdx | 6 +- .../0.19/qiskit.circuit.library.CRXGate.mdx | 6 +- .../0.19/qiskit.circuit.library.CRYGate.mdx | 6 +- .../0.19/qiskit.circuit.library.CRZGate.mdx | 6 +- .../0.19/qiskit.circuit.library.CSwapGate.mdx | 6 +- .../0.19/qiskit.circuit.library.CU1Gate.mdx | 6 +- .../0.19/qiskit.circuit.library.CU3Gate.mdx | 6 +- .../0.19/qiskit.circuit.library.CXGate.mdx | 6 +- .../0.19/qiskit.circuit.library.CYGate.mdx | 6 +- .../0.19/qiskit.circuit.library.CZGate.mdx | 6 +- .../0.19/qiskit.circuit.library.DCXGate.mdx | 2 +- .../0.19/qiskit.circuit.library.Diagonal.mdx | 8 +-- .../qiskit.circuit.library.EfficientSU2.mdx | 34 +++++----- ...t.circuit.library.ExcitationPreserving.mdx | 34 +++++----- ...qiskit.circuit.library.FourierChecking.mdx | 8 +-- ...rcuit.library.FunctionalPauliRotations.mdx | 14 ++--- .../0.19/qiskit.circuit.library.GMS.mdx | 8 +-- .../qiskit.circuit.library.GraphState.mdx | 8 +-- .../0.19/qiskit.circuit.library.HGate.mdx | 2 +- ...t.circuit.library.HiddenLinearFunction.mdx | 8 +-- .../0.19/qiskit.circuit.library.IGate.mdx | 2 +- .../0.19/qiskit.circuit.library.IQP.mdx | 8 +-- .../qiskit.circuit.library.InnerProduct.mdx | 8 +-- ...skit.circuit.library.IntegerComparator.mdx | 16 ++--- ...t.circuit.library.LinearPauliRotations.mdx | 18 +++--- .../0.19/qiskit.circuit.library.MCMT.mdx | 8 +-- .../qiskit.circuit.library.MCMTVChain.mdx | 8 +-- .../0.19/qiskit.circuit.library.MSGate.mdx | 2 +- .../0.19/qiskit.circuit.library.NLocal.mdx | 34 +++++----- .../qiskit/0.19/qiskit.circuit.library.OR.mdx | 8 +-- ...qiskit.circuit.library.PauliFeatureMap.mdx | 34 +++++----- .../qiskit.circuit.library.Permutation.mdx | 8 +-- ....library.PiecewiseLinearPauliRotations.mdx | 26 ++++---- ...rcuit.library.PolynomialPauliRotations.mdx | 20 +++--- .../0.19/qiskit.circuit.library.QFT.mdx | 16 ++--- .../qiskit.circuit.library.QuantumVolume.mdx | 8 +-- .../0.19/qiskit.circuit.library.RC3XGate.mdx | 2 +- .../0.19/qiskit.circuit.library.RCCXGate.mdx | 2 +- .../0.19/qiskit.circuit.library.RXGate.mdx | 2 +- .../0.19/qiskit.circuit.library.RXXGate.mdx | 2 +- .../0.19/qiskit.circuit.library.RYGate.mdx | 2 +- .../0.19/qiskit.circuit.library.RYYGate.mdx | 2 +- .../0.19/qiskit.circuit.library.RZGate.mdx | 2 +- .../0.19/qiskit.circuit.library.RZXGate.mdx | 2 +- .../0.19/qiskit.circuit.library.RZZGate.mdx | 2 +- .../qiskit.circuit.library.RealAmplitudes.mdx | 34 +++++----- .../0.19/qiskit.circuit.library.SGate.mdx | 2 +- .../0.19/qiskit.circuit.library.SdgGate.mdx | 2 +- .../0.19/qiskit.circuit.library.SwapGate.mdx | 2 +- .../0.19/qiskit.circuit.library.TGate.mdx | 2 +- .../0.19/qiskit.circuit.library.TdgGate.mdx | 2 +- .../0.19/qiskit.circuit.library.TwoLocal.mdx | 34 +++++----- .../0.19/qiskit.circuit.library.U1Gate.mdx | 2 +- .../0.19/qiskit.circuit.library.U2Gate.mdx | 2 +- .../0.19/qiskit.circuit.library.U3Gate.mdx | 2 +- .../qiskit.circuit.library.WeightedAdder.mdx | 20 +++--- .../0.19/qiskit.circuit.library.XGate.mdx | 2 +- .../0.19/qiskit.circuit.library.XOR.mdx | 8 +-- .../0.19/qiskit.circuit.library.YGate.mdx | 2 +- .../qiskit.circuit.library.ZFeatureMap.mdx | 34 +++++----- .../0.19/qiskit.circuit.library.ZGate.mdx | 2 +- .../qiskit.circuit.library.ZZFeatureMap.mdx | 34 +++++----- .../0.19/qiskit.circuit.library.iSwapGate.mdx | 2 +- .../qiskit.extensions.HamiltonianGate.mdx | 2 +- .../0.19/qiskit.extensions.UnitaryGate.mdx | 2 +- ...qiskit.finance.data_providers.DataType.mdx | 8 +-- ...kit.finance.data_providers.StockMarket.mdx | 12 ++-- ....ignis.characterization.AmpCalCXFitter.mdx | 18 +++--- ...it.ignis.characterization.AmpCalFitter.mdx | 18 +++--- ...gnis.characterization.AngleCalCXFitter.mdx | 18 +++--- ....ignis.characterization.AngleCalFitter.mdx | 18 +++--- ...s.characterization.BaseCoherenceFitter.mdx | 18 +++--- ....ignis.characterization.BaseGateFitter.mdx | 18 +++--- ...skit.ignis.characterization.DragFitter.mdx | 18 +++--- ...skit.ignis.characterization.RabiFitter.mdx | 18 +++--- ...qiskit.ignis.characterization.T1Fitter.mdx | 18 +++--- ...qiskit.ignis.characterization.T2Fitter.mdx | 18 +++--- ...it.ignis.characterization.T2StarFitter.mdx | 18 +++--- ...qiskit.ignis.characterization.ZZFitter.mdx | 18 +++--- .../0.19/qiskit.ignis.logging.IgnisLogger.mdx | 4 +- ...ignis.verification.AccreditationFitter.mdx | 16 ++--- .../qiskit.optimization.QuadraticProgram.mdx | 18 +++--- ...optimization.algorithms.CplexOptimizer.mdx | 2 +- ...ptimization.algorithms.GroverOptimizer.mdx | 2 +- ...iskit.optimization.problems.Constraint.mdx | 8 +-- ...optimization.problems.LinearConstraint.mdx | 10 +-- ...optimization.problems.LinearExpression.mdx | 4 +- ...imization.problems.QuadraticConstraint.mdx | 12 ++-- ...imization.problems.QuadraticExpression.mdx | 4 +- ...timization.problems.QuadraticObjective.mdx | 10 +-- ...optimization.problems.QuadraticProgram.mdx | 18 +++--- .../qiskit.optimization.problems.Variable.mdx | 10 +-- .../0.19/qiskit.providers.JobStatus.mdx | 14 ++--- .../qiskit.providers.aer.PulseSimulator.mdx | 2 +- .../qiskit.providers.aer.QasmSimulator.mdx | 4 +- ...kit.providers.aer.StatevectorSimulator.mdx | 4 +- .../qiskit.providers.aer.UnitarySimulator.mdx | 4 +- ...kit.providers.basicaer.QasmSimulatorPy.mdx | 8 +-- ...viders.basicaer.StatevectorSimulatorPy.mdx | 8 +-- ....providers.basicaer.UnitarySimulatorPy.mdx | 6 +- .../qiskit.providers.models.BackendStatus.mdx | 2 +- ...iders.models.PulseBackendConfiguration.mdx | 2 +- docs/api/qiskit/0.19/qiskit.pulse.Acquire.mdx | 38 ++++++------ .../0.19/qiskit.pulse.AcquireChannel.mdx | 6 +- .../api/qiskit/0.19/qiskit.pulse.Constant.mdx | 6 +- .../0.19/qiskit.pulse.ControlChannel.mdx | 6 +- docs/api/qiskit/0.19/qiskit.pulse.Delay.mdx | 22 +++---- docs/api/qiskit/0.19/qiskit.pulse.Drag.mdx | 10 +-- .../qiskit/0.19/qiskit.pulse.DriveChannel.mdx | 6 +- .../api/qiskit/0.19/qiskit.pulse.Gaussian.mdx | 8 +-- .../0.19/qiskit.pulse.GaussianSquare.mdx | 10 +-- .../qiskit/0.19/qiskit.pulse.Instruction.mdx | 20 +++--- .../qiskit.pulse.InstructionScheduleMap.mdx | 2 +- .../0.19/qiskit.pulse.MeasureChannel.mdx | 6 +- .../qiskit/0.19/qiskit.pulse.MemorySlot.mdx | 6 +- docs/api/qiskit/0.19/qiskit.pulse.Play.mdx | 24 +++---- .../qiskit/0.19/qiskit.pulse.RegisterSlot.mdx | 6 +- .../qiskit/0.19/qiskit.pulse.SamplePulse.mdx | 4 +- .../api/qiskit/0.19/qiskit.pulse.Schedule.mdx | 16 ++--- .../qiskit/0.19/qiskit.pulse.SetFrequency.mdx | 24 +++---- .../qiskit/0.19/qiskit.pulse.ShiftPhase.mdx | 24 +++---- .../api/qiskit/0.19/qiskit.pulse.Snapshot.mdx | 26 ++++---- .../api/qiskit/0.19/qiskit.pulse.channels.mdx | 36 +++++------ .../qiskit.pulse.instructions.Acquire.mdx | 38 ++++++------ .../0.19/qiskit.pulse.instructions.Delay.mdx | 22 +++---- .../qiskit.pulse.instructions.Instruction.mdx | 20 +++--- .../0.19/qiskit.pulse.instructions.Play.mdx | 24 +++---- ...qiskit.pulse.instructions.SetFrequency.mdx | 24 +++---- .../qiskit.pulse.instructions.ShiftPhase.mdx | 24 +++---- .../qiskit.pulse.instructions.Snapshot.mdx | 26 ++++---- .../0.19/qiskit.pulse.pulse_lib.Constant.mdx | 6 +- .../0.19/qiskit.pulse.pulse_lib.Drag.mdx | 10 +-- .../0.19/qiskit.pulse.pulse_lib.Gaussian.mdx | 8 +-- .../qiskit.pulse.pulse_lib.GaussianSquare.mdx | 10 +-- .../qiskit.pulse.pulse_lib.SamplePulse.mdx | 4 +- .../qiskit/0.19/qiskit.qasm.OpenQASMLexer.mdx | 18 +++--- .../qiskit/0.19/qiskit.qasm.QasmHTMLStyle.mdx | 14 ++--- .../0.19/qiskit.qasm.QasmTerminalStyle.mdx | 14 ++--- docs/api/qiskit/0.19/qiskit.result.Result.mdx | 4 +- .../0.19/qiskit.transpiler.FlowController.mdx | 2 +- .../0.19/qiskit.validation.BaseSchema.mdx | 10 +-- .../qiskit.validation.ModelTypeValidator.mdx | 10 +-- scripts/lib/api/generateApiComponents.ts | 62 +++++-------------- scripts/lib/api/htmlToMd.test.ts | 4 +- 218 files changed, 1085 insertions(+), 1115 deletions(-) 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 7337f2edaad..725e0c48ff4 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 @@ -175,7 +175,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### dt - + Return the system time resolution of input signals This is required to be implemented if the backend supports Pulse scheduling. @@ -193,7 +193,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### dtm - + Return the system time resolution of output signals :returns: The output signal timestep in seconds. :rtype: dtm @@ -201,7 +201,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### id\_warning\_issued - + @@ -223,7 +223,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### instructions - + A list of Instruction tuples on the backend of the form `(instruction, (qubits)` **Return type** @@ -235,7 +235,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### max\_circuits - + The maximum number of circuits The maximum number of circuits that can be run in a single job. If there is no limit this will return None. **Return type** @@ -247,7 +247,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### meas\_map - + Return the grouping of measurements which are multiplexed This is required to be implemented if the backend supports Pulse scheduling. :returns: The grouping of measurements which are multiplexed :rtype: meas\_map @@ -263,7 +263,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### num\_qubits - + Return the number of qubits the backend has. **Return type** @@ -283,7 +283,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### operation\_names - + A list of instruction names that the backend supports. **Return type** @@ -295,7 +295,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### operations - + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v0.45)") instances that the backend supports. **Return type** @@ -333,7 +333,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### session - + Return session **Return type** @@ -345,7 +345,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### target - + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.45)") object for the backend. :rtype: [`Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v0.45)") :returns: Target @@ -353,7 +353,7 @@ python_api_name: qiskit_ibm_provider.IBMBackend ### version - + ## Methods 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 84308023720..7a2c00a7798 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 @@ -112,7 +112,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### backend - + Return the backend service. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit_ibm_provider.IBMProvider ### version - + ## Methods 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 589c023f54f..a5f16df466b 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 @@ -56,7 +56,7 @@ python_api_name: qiskit_ibm_provider.Session ### active - + Return the status of the session. **Return type** @@ -72,7 +72,7 @@ python_api_name: qiskit_ibm_provider.Session ### session\_id - + Return the session ID. **Return type** 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 170bc3277ab..eb08c13d172 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 @@ -72,7 +72,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob ### client\_version - + Return version of the client used for this job. **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob ### usage\_estimation - + Return usage estimation information for this job. **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCircuitJob ### version - + ## Methods 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 cf6bd388c6c..eef9c2d9e7a 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 @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob ### client\_version - + Return version of the client used for this job. **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit_ibm_provider.job.IBMCompositeJob ### version - + ## Methods 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 87b3b8156e7..89dd742e0da 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 @@ -31,7 +31,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo ### estimated\_complete\_time - + Return estimated complete time in local time. **Return type** @@ -43,7 +43,7 @@ python_api_name: qiskit_ibm_provider.job.QueueInfo ### estimated\_start\_time - + Return estimated start time in local time. **Return type** 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 e77531efb12..9f0cbbcb608 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 @@ -19,13 +19,13 @@ python_api_name: qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuit ### MEASURE\_PATCH\_CYCLES - + ### MEASURE\_PATCH\_ODD\_OFFSET - + ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.mdx b/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.mdx index 77900d103d8..1aeedce2e5d 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.QuantumInstance.mdx @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.QuantumInstance ### BACKEND\_OPTIONS\_QASM\_ONLY - + ### backend 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 5aa8aaf6369..c58dc452d21 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.AmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.AmplitudeEstimation.mdx @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation ### quantum\_instance - + Returns quantum instance. **Return type** 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 d2486165a37..57050baae16 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.BernsteinVazirani.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.BernsteinVazirani.mdx @@ -22,7 +22,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### backend - + Returns backend. **Return type** @@ -32,7 +32,7 @@ python_api_name: qiskit.aqua.algorithms.BernsteinVazirani ### quantum\_instance - + Returns quantum instance. **Return type** 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 a120df97c6e..c14f6c9adf9 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.DeutschJozsa.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.DeutschJozsa.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### backend - + Returns backend. **Return type** @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.algorithms.DeutschJozsa ### quantum\_instance - + Returns quantum instance. **Return type** 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 e05a128a2ff..0c77cc70580 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.EOH.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.EOH.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### backend - + Returns backend. **Return type** @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.EOH ### quantum\_instance - + Returns quantum instance. **Return type** 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 1cbbd061d44..15a696c0f6f 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Grover.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Grover.mdx @@ -40,7 +40,7 @@ python_api_name: qiskit.aqua.algorithms.Grover ### backend - + Returns backend. **Return type** @@ -56,7 +56,7 @@ python_api_name: qiskit.aqua.algorithms.Grover ### quantum\_instance - + Returns quantum instance. **Return type** 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 9e0788334e2..23852c7c409 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.HHL.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.HHL.mdx @@ -54,7 +54,7 @@ $$ ### backend - + Returns backend. **Return type** @@ -64,7 +64,7 @@ $$ ### quantum\_instance - + Returns quantum instance. **Return type** 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 264b54dccbc..bb46cf1348b 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IQPE.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IQPE.mdx @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### aux\_operators - + Returns aux operators **Return type** @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### backend - + Returns backend. **Return type** @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### operator - + Returns operator **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.algorithms.IQPE ### quantum\_instance - + Returns quantum instance. **Return type** 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 51303f84f7a..9427158843c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.mdx @@ -54,7 +54,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -84,7 +84,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### precision - + Returns the target precision epsilon of the algorithm. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation ### quantum\_instance - + Returns quantum instance. **Return type** 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 db622b3f59c..81ad5c91db8 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### backend - + Returns backend. **Return type** @@ -94,7 +94,7 @@ python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation ### quantum\_instance - + Returns quantum instance. **Return type** 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 33823caeaaa..4c130704983 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolver.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolver.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolver ### operator - + Return the operator. **Return type** 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 829aecaf57b..84252644690 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.MinimumEigensolverResult.mdx @@ -15,7 +15,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### aux\_operator\_eigenvalues - + return aux operator eigen values **Return type** @@ -25,7 +25,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenstate - + return eigen state **Return type** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult ### eigenvalue - + returns eigen value **Return type** 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 d1449351ed1..783f00917f8 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyEigensolver.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyEigensolver.mdx @@ -27,7 +27,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### aux\_operators - + returns aux operators **Return type** @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### k - + returns k (number of eigenvalues requested) **Return type** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyEigensolver ### operator - + returns operator **Return type** 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 8ccdb2d2f40..0ab5fa76d5a 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.NumPyMinimumEigensolver.mdx @@ -20,7 +20,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -30,7 +30,7 @@ python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver ### operator - + Return the operator. **Return type** 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 20ebaaacdbe..6b85fd6ffd7 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QAOA.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QAOA.mdx @@ -38,7 +38,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### aux\_operators - + Returns aux operators **Return type** @@ -48,7 +48,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### backend - + Returns backend. **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### initial\_point - + Returns initial point **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### operator - + Returns operator **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### optimizer - + Returns optimizer **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### quantum\_instance - + Returns quantum instance. **Return type** @@ -130,7 +130,7 @@ python_api_name: qiskit.aqua.algorithms.QAOA ### var\_form - + Returns variational form **Return type** 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 1bc35d4093b..75119f43977 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QGAN.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QGAN.mdx @@ -45,7 +45,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### backend - + Returns backend. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.aqua.algorithms.QGAN ### quantum\_instance - + Returns quantum instance. **Return type** 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 60acf7681d3..f3c9afb94a5 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QPE.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QPE.mdx @@ -29,7 +29,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### aux\_operators - + Returns aux operators **Return type** @@ -39,7 +39,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### backend - + Returns backend. **Return type** @@ -49,7 +49,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### operator - + Returns operator **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.aqua.algorithms.QPE ### quantum\_instance - + Returns quantum instance. **Return type** 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 5cb147d099b..9b55a049d02 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QSVM.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QSVM.mdx @@ -36,11 +36,11 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### BATCH\_SIZE - + ### backend - + Returns backend. **Return type** @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.algorithms.QSVM ### quantum\_instance - + Returns quantum instance. **Return type** 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 e65dc138c21..11636835f9c 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QuantumAlgorithm.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.QuantumAlgorithm.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### backend - + Returns backend. **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm ### quantum\_instance - + Returns quantum instance. **Return type** 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 0a4aacdfce4..79f9fc033ce 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Shor.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Shor.mdx @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### backend - + Returns backend. **Return type** @@ -47,7 +47,7 @@ python_api_name: qiskit.aqua.algorithms.Shor ### quantum\_instance - + Returns quantum instance. **Return type** 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 913c946d9bb..2850badbf93 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Simon.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.Simon.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### backend - + Returns backend. **Return type** @@ -34,7 +34,7 @@ python_api_name: qiskit.aqua.algorithms.Simon ### quantum\_instance - + Returns quantum instance. **Return type** 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 9ed774b3070..9f07760eb2e 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQC.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQC.mdx @@ -42,7 +42,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### backend - + Returns backend. **Return type** @@ -64,7 +64,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### feature\_map - + Return the feature map. **Return type** @@ -74,7 +74,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### initial\_point - + Returns initial point **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### optimizer - + Returns optimizer **Return type** @@ -106,7 +106,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### quantum\_instance - + Returns quantum instance. **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.aqua.algorithms.VQC ### var\_form - + Returns variational form **Return type** 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 66107f2e043..f96955706e0 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQE.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.algorithms.VQE.mdx @@ -40,7 +40,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### aux\_operators - + Returns aux operators **Return type** @@ -50,7 +50,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### backend - + Returns backend. **Return type** @@ -60,7 +60,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -70,7 +70,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### initial\_point - + Returns initial point **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### operator - + Returns operator **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -100,7 +100,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### optimizer - + Returns optimizer **Return type** @@ -110,7 +110,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -132,7 +132,7 @@ python_api_name: qiskit.aqua.algorithms.VQE ### var\_form - + Returns variational form **Return type** 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 23c912d4541..4cc682c6095 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 @@ -22,7 +22,7 @@ python_api_name: qiskit.aqua.components.oracles.Oracle ### ancillary\_register - + returns ancillary register @@ -32,13 +32,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.19/qiskit.aqua.operators.OperatorBase.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.mdx index 7322184f88f..fd5346c83fd 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.operators.OperatorBase.mdx @@ -17,7 +17,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** 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 c5dde5173ae..7896617f3e2 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 @@ -28,7 +28,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### backend - + Returns the backend. **Return type** @@ -42,7 +42,7 @@ python_api_name: qiskit.aqua.operators.converters.CircuitSampler ### quantum\_instance - + Returns the quantum instance. **Return type** 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 0b7b8bb570c..146ed919032 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 @@ -32,7 +32,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** 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 679c22c0277..aba216e379b 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 @@ -20,7 +20,7 @@ python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -34,7 +34,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** @@ -48,7 +48,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.19/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.PauliTrotterEvolution.mdx index 17e11517474..1e92ed9cf05 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 @@ -27,7 +27,7 @@ python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution ### trotter - + TrotterizationBase used to evolve SummedOps. **Return type** 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 a3ccf9d7347..b2870e97c22 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 @@ -19,7 +19,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.19/qiskit.aqua.operators.evolutions.Suzuki.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Suzuki.mdx index eb6ee13b98e..d8d5e60af36 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 @@ -22,7 +22,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Suzuki ### order - + returns order **Return type** @@ -32,7 +32,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.19/qiskit.aqua.operators.evolutions.Trotter.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.Trotter.mdx index 17125160ec9..4a34704f4e3 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 @@ -19,7 +19,7 @@ python_api_name: qiskit.aqua.operators.evolutions.Trotter ### order - + returns order **Return type** @@ -29,7 +29,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.19/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.evolutions.TrotterizationBase.mdx index f0594cb1706..b403809aed8 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 @@ -15,7 +15,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.19/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.legacy.LegacyBaseOperator.mdx index c38339aa336..4a7943ee4fe 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 @@ -29,7 +29,7 @@ python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator ### num\_qubits - + Returns number of qubits for operator 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 0cc5343e6b0..2bc897d6bec 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 @@ -21,7 +21,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** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -49,7 +49,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** @@ -63,7 +63,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** @@ -77,7 +77,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** @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ComposedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** 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 f34aceccc71..c1bea08ba1a 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 @@ -29,7 +29,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** @@ -43,7 +43,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -57,7 +57,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** @@ -71,7 +71,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** @@ -85,7 +85,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** @@ -99,7 +99,7 @@ python_api_name: qiskit.aqua.operators.list_ops.ListOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** 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 88e42bfe9ff..82b3a6235f7 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 @@ -21,7 +21,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** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -49,7 +49,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** @@ -63,7 +63,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** @@ -77,7 +77,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** @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.operators.list_ops.SummedOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** 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 ab63cfcb831..ed05f382a26 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 @@ -21,7 +21,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** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -49,7 +49,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** @@ -63,7 +63,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** @@ -77,7 +77,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** @@ -91,7 +91,7 @@ python_api_name: qiskit.aqua.operators.list_ops.TensoredOp ### oplist - + The list of `OperatorBases` defining the underlying function of this Operator. **Return type** 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 d920c34f24c..d8bc30c3475 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 @@ -25,7 +25,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -39,7 +39,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** @@ -53,7 +53,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.19/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.MatrixOp.mdx index 3bb30fd1550..1eec3dd0240 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 @@ -25,7 +25,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -39,7 +39,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** @@ -53,7 +53,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.19/qiskit.aqua.operators.primitive_ops.PauliOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PauliOp.mdx index d3b6672cdf1..d01173698d7 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 @@ -24,7 +24,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -38,7 +38,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** @@ -52,7 +52,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.19/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.primitive_ops.PrimitiveOp.mdx index a472a49e95c..3d6f741707b 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 @@ -29,7 +29,7 @@ python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp ### coeff - + The scalar coefficient multiplying the Operator. **Return type** @@ -43,7 +43,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** @@ -57,7 +57,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.19/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx b/docs/api/qiskit/0.19/qiskit.aqua.operators.state_fns.CircuitStateFn.mdx index cbb8958364c..6bcc62ae1c1 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 @@ -25,7 +25,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -45,7 +45,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** 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 640ed7c2e41..ade0edc6df6 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 @@ -25,7 +25,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -35,7 +35,7 @@ python_api_name: qiskit.aqua.operators.state_fns.DictStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -45,7 +45,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** 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 0d8295db388..5a1c2979f7f 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 @@ -21,7 +21,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -41,7 +41,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** 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 a02a1008e5e..53d61d882af 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 @@ -27,7 +27,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -37,7 +37,7 @@ python_api_name: qiskit.aqua.operators.state_fns.StateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -47,7 +47,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** 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 07b0dee4f4e..64cc4112590 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 @@ -21,7 +21,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### coeff - + A coefficient by which the state function is multiplied. **Return type** @@ -31,7 +31,7 @@ python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn ### is\_measurement - + Whether the StateFn object is a measurement Operator. **Return type** @@ -41,7 +41,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** diff --git a/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.mdx index 27e12c861f3..1a1408b28c4 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.QMolecule.mdx @@ -21,19 +21,19 @@ python_api_name: qiskit.chemistry.QMolecule ### BOHR - + ### DEBYE - + ### QMOLECULE\_VERSION - + ### core\_orbitals - + Returns: A list of core orbital indices. **Return type** @@ -55,7 +55,7 @@ python_api_name: qiskit.chemistry.QMolecule ### symbols - + ### two\_body\_integrals 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 de5ed504b97..8f2885b01c0 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomEE.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomEE.mdx @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### aux\_operators - + Returns the auxiliary operators. **Return type** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomEE ### operator - + Return the operator. **Return type** 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 75cce95eb6d..793b3cb256e 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomVQE.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.QEomVQE.mdx @@ -41,7 +41,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### aux\_operators - + Returns aux operators **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### backend - + Returns backend. **Return type** @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### expectation - + The expectation value algorithm used to construct the expectation measurement from the observable. **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### initial\_point - + Returns initial point **Return type** @@ -81,7 +81,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### operator - + Returns operator **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimal\_params - + The optimal parameters for the variational form. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### optimizer - + Returns optimizer **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### quantum\_instance - + Returns quantum instance. **Return type** @@ -133,7 +133,7 @@ python_api_name: qiskit.chemistry.algorithms.QEomVQE ### var\_form - + Returns variational form **Return type** 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 333e5a0214a..66293afa759 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.VQEAdapt.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.algorithms.VQEAdapt.mdx @@ -35,7 +35,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### backend - + Returns backend. **Return type** @@ -45,7 +45,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### initial\_point - + Returns initial point **Return type** @@ -61,7 +61,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### optimizer - + Returns optimizer **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### quantum\_instance - + Returns quantum instance. **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.algorithms.VQEAdapt ### var\_form - + Returns variational form **Return type** 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 2bd83d8ddbc..5192e0807b2 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.ChemistryOperator.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.ChemistryOperator.mdx @@ -15,19 +15,19 @@ python_api_name: qiskit.chemistry.core.ChemistryOperator ### INFO\_NUM\_ORBITALS - + ### INFO\_NUM\_PARTICLES - + ### INFO\_TWO\_QUBIT\_REDUCTION - + ### INFO\_Z2SYMMETRIES - + ### molecule\_info 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 b53675f304e..f40f68cc63b 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.Hamiltonian.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.Hamiltonian.mdx @@ -28,19 +28,19 @@ python_api_name: qiskit.chemistry.core.Hamiltonian ### INFO\_NUM\_ORBITALS - + ### INFO\_NUM\_PARTICLES - + ### INFO\_TWO\_QUBIT\_REDUCTION - + ### INFO\_Z2SYMMETRIES - + ### molecule\_info 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 ce58b403d45..142dc500099 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularChemistryResult.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularChemistryResult.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.chemistry.core.MolecularChemistryResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -37,7 +37,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** @@ -47,7 +47,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.19/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx index 6b529887c8d..dc526fe9911 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularExcitedStatesResult.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### energies - + Returns ground state energy **Return type** @@ -37,7 +37,7 @@ python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -47,7 +47,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** @@ -57,7 +57,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.19/qiskit.chemistry.core.MolecularGroundStateResult.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularGroundStateResult.mdx index 4be0168344f..569f64e7989 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularGroundStateResult.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.MolecularGroundStateResult.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### algorithm\_result - + Returns raw algorithm result **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_dipole\_moment - + Returns computed electronic part of dipole moment **Return type** @@ -37,7 +37,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### computed\_electronic\_energy - + Returns computed electronic part of ground state energy **Return type** @@ -47,7 +47,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment - + Returns dipole moment **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### dipole\_moment\_in\_debye - + Returns dipole moment in Debye **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_dipole\_moment - + Returns electronic dipole moment **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### electronic\_energy - + Returns electronic part of ground state energy **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### energy - + Returns ground state energy if nuclear\_repulsion\_energy is available from driver **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### formatted - + Formatted result as a list of strings **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_dipole\_moment - + Returns frozen extracted part of dipole moment **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### frozen\_extracted\_energy - + Returns frozen extracted part of ground state energy **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### hartree\_fock\_energy - + Returns Hartree-Fock energy **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### magnetization - + Returns measured magnetization **Return type** @@ -147,7 +147,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** @@ -157,7 +157,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### nuclear\_repulsion\_energy - + Returns nuclear repulsion energy when available from driver **Return type** @@ -167,7 +167,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### num\_particles - + Returns measured number of particles **Return type** @@ -177,7 +177,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_dipole\_moment - + Returns particle hole extracted part of dipole moment **Return type** @@ -187,7 +187,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### ph\_extracted\_energy - + Returns particle hole extracted part of ground state energy **Return type** @@ -197,7 +197,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** @@ -207,7 +207,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### spin - + Returns computed spin **Return type** @@ -217,7 +217,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_angular\_momentum - + Returns total angular momentum (S^2) **Return type** @@ -227,7 +227,7 @@ python_api_name: qiskit.chemistry.core.MolecularGroundStateResult ### total\_dipole\_moment - + Returns total dipole of moment **Return type** @@ -237,7 +237,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.19/qiskit.chemistry.core.QubitMappingType.mdx b/docs/api/qiskit/0.19/qiskit.chemistry.core.QubitMappingType.mdx index bcfc058301e..cf94a8c54f8 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.QubitMappingType.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.QubitMappingType.mdx @@ -15,14 +15,14 @@ python_api_name: qiskit.chemistry.core.QubitMappingType ### BRAVYI\_KITAEV - + ### JORDAN\_WIGNER - + ### PARITY - + 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 09eeb1be7ea..2c65c8c15e0 100644 --- a/docs/api/qiskit/0.19/qiskit.chemistry.core.TransformationType.mdx +++ b/docs/api/qiskit/0.19/qiskit.chemistry.core.TransformationType.mdx @@ -15,10 +15,10 @@ python_api_name: qiskit.chemistry.core.TransformationType ### FULL - + ### PARTICLE\_HOLE - + diff --git a/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.mdx b/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.mdx index 5166e5fa8dd..232ff4be0a9 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.ClassicalRegister.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### instances\_counter - + ### name @@ -27,7 +27,7 @@ python_api_name: qiskit.circuit.ClassicalRegister ### prefix - + ### size diff --git a/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.mdx index e280552ec88..947c403d6b4 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.ControlledGate.mdx @@ -85,7 +85,7 @@ python_api_name: qiskit.circuit.ControlledGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.circuit.ControlledGate ### 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** @@ -111,7 +111,7 @@ python_api_name: qiskit.circuit.ControlledGate ### label - + Return gate label **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.Gate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.Gate.mdx index 6881d7c1bbb..6adbf49d2bc 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.Gate.mdx @@ -36,7 +36,7 @@ python_api_name: qiskit.circuit.Gate ### label - + Return gate label **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.mdx index c481d2c26cc..cb04843cfe9 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.QuantumCircuit.mdx @@ -141,15 +141,15 @@ python_api_name: qiskit.circuit.QuantumCircuit ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -183,7 +183,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### prefix - + ### qubits diff --git a/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.mdx b/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.mdx index 8dca9035d7a..87af09e85a2 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.QuantumRegister.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### instances\_counter - + ### name @@ -27,7 +27,7 @@ python_api_name: qiskit.circuit.QuantumRegister ### prefix - + ### size 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 e132d6d4cc4..72b461b75bf 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.AND.mdx @@ -51,15 +51,15 @@ python_api_name: qiskit.circuit.library.AND ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -93,7 +93,7 @@ python_api_name: qiskit.circuit.library.AND ### prefix - + ### qubits 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 7eb4691e41d..d0df52232fc 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.C3XGate.mdx @@ -29,7 +29,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -45,7 +45,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### 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** @@ -55,7 +55,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### label - + Return gate label **Return type** 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 612f04731b1..a1fdfddc31e 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.C4XGate.mdx @@ -23,7 +23,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -39,7 +39,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### 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** @@ -49,7 +49,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### label - + Return gate label **Return type** 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 5c3216151a1..fdd922d3e6b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CCXGate.mdx @@ -73,7 +73,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -89,7 +89,7 @@ $$ ### 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** @@ -99,7 +99,7 @@ $$ ### label - + Return gate label **Return type** 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 e33025ff3a0..f0be46e4222 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CHGate.mdx @@ -66,7 +66,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -82,7 +82,7 @@ $$ ### 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** @@ -92,7 +92,7 @@ $$ ### label - + Return gate label **Return type** 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 b7ceec7d1cc..3e8de5cb31d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CRXGate.mdx @@ -61,7 +61,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -77,7 +77,7 @@ $$ ### 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** @@ -87,7 +87,7 @@ $$ ### label - + Return gate label **Return type** 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 abada674b66..c2a98f5bb86 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CRYGate.mdx @@ -62,7 +62,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -78,7 +78,7 @@ $$ ### 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** @@ -88,7 +88,7 @@ $$ ### label - + Return gate label **Return type** 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 2f8f4bca9d3..c50ca54f699 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CRZGate.mdx @@ -67,7 +67,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -83,7 +83,7 @@ $$ ### 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** @@ -93,7 +93,7 @@ $$ ### label - + Return gate label **Return type** 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 82ca46aa761..4dc76bb38e8 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CSwapGate.mdx @@ -80,7 +80,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -96,7 +96,7 @@ $$ ### 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** @@ -106,7 +106,7 @@ $$ ### label - + Return gate label **Return type** 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 9d9de4d64a7..45c01c152d6 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CU1Gate.mdx @@ -44,7 +44,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -60,7 +60,7 @@ $$ ### 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** @@ -70,7 +70,7 @@ $$ ### label - + Return gate label **Return type** 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 bd4ff9cf26f..0a7aa0fb266 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CU3Gate.mdx @@ -65,7 +65,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -81,7 +81,7 @@ $$ ### 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** @@ -91,7 +91,7 @@ $$ ### label - + Return gate label **Return type** 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 bee7fb6e854..1846fb1dbaa 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CXGate.mdx @@ -67,7 +67,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -83,7 +83,7 @@ $$ ### 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** @@ -93,7 +93,7 @@ $$ ### label - + Return gate label **Return type** 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 09cbcc70ce2..a561007c3c4 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CYGate.mdx @@ -61,7 +61,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -77,7 +77,7 @@ $$ ### 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** @@ -87,7 +87,7 @@ $$ ### label - + Return gate label **Return type** 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 e326d3229f2..bcce88db268 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.CZGate.mdx @@ -42,7 +42,7 @@ $$ ### ctrl\_state - + Return the control state of the gate as a decimal integer. **Return type** @@ -58,7 +58,7 @@ $$ ### 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** @@ -68,7 +68,7 @@ $$ ### label - + Return gate label **Return type** 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 7f8add6069b..1b41b63c1a0 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.DCXGate.mdx @@ -51,7 +51,7 @@ $$ ### label - + Return gate label **Return type** 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 46336542af8..0ae9ea9da8d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Diagonal.mdx @@ -83,15 +83,15 @@ $$ ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -125,7 +125,7 @@ $$ ### prefix - + ### qubits 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 173f33881c0..3c3c1f75025 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.EfficientSU2.mdx @@ -99,7 +99,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement - + Get the entanglement strategy. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -127,15 +127,15 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### extension\_lib - + ### header - + ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -163,7 +163,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### instances - + ### n\_qubits @@ -179,7 +179,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -199,7 +199,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. @@ -219,7 +219,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -233,7 +233,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -263,7 +263,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -277,7 +277,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -291,7 +291,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** @@ -305,7 +305,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### prefix - + ### qregs @@ -321,7 +321,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -335,7 +335,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.19/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving.mdx index cce88f1c985..469eae992f0 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ExcitationPreserving.mdx @@ -117,7 +117,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -131,7 +131,7 @@ $$ ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -145,15 +145,15 @@ $$ ### extension\_lib - + ### header - + ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -167,7 +167,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -181,7 +181,7 @@ $$ ### instances - + ### n\_qubits @@ -197,7 +197,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -217,7 +217,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. @@ -237,7 +237,7 @@ $$ ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -251,7 +251,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -281,7 +281,7 @@ $$ ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -295,7 +295,7 @@ $$ ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -309,7 +309,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -323,7 +323,7 @@ $$ ### prefix - + ### qregs @@ -339,7 +339,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -353,7 +353,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** 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 8e8c7f69a15..d297f53ee31 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.FourierChecking.mdx @@ -64,15 +64,15 @@ python_api_name: qiskit.circuit.library.FourierChecking ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -106,7 +106,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### prefix - + ### qubits 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 eb6850acfdf..77787ed95b6 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -23,7 +23,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. @@ -61,15 +61,15 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -79,7 +79,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -131,7 +131,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### prefix - + ### qregs 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 9415fe3fce3..a335c146249 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.GMS.mdx @@ -73,15 +73,15 @@ $$ ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -115,7 +115,7 @@ $$ ### prefix - + ### qubits 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 da2738b0b0f..f6927faa31a 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.GraphState.mdx @@ -67,15 +67,15 @@ $$ ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -109,7 +109,7 @@ $$ ### prefix - + ### qubits 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 626fcd29fe9..5051fccef10 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.HGate.mdx @@ -49,7 +49,7 @@ $$ ### label - + Return gate label **Return type** 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 1848095110b..5954999a92f 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -71,15 +71,15 @@ $$ ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -113,7 +113,7 @@ $$ ### prefix - + ### qubits 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 154d98d17cd..2f75d52cf53 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.IGate.mdx @@ -48,7 +48,7 @@ $$ ### label - + Return gate label **Return type** 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 4877f37289e..f8e2084db85 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.IQP.mdx @@ -63,15 +63,15 @@ python_api_name: qiskit.circuit.library.IQP ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -105,7 +105,7 @@ python_api_name: qiskit.circuit.library.IQP ### prefix - + ### qubits 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 d4c2ec4a615..4b38f69ca77 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.InnerProduct.mdx @@ -47,15 +47,15 @@ python_api_name: qiskit.circuit.library.InnerProduct ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -89,7 +89,7 @@ python_api_name: qiskit.circuit.library.InnerProduct ### prefix - + ### qubits 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 aff41e0345e..81161467dfd 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.IntegerComparator.mdx @@ -54,11 +54,11 @@ $$ ### extension\_lib - + ### geq - + Return whether the comparator compares greater or less equal. **Return type** @@ -72,11 +72,11 @@ $$ ### header - + ### instances - + ### n\_qubits @@ -86,7 +86,7 @@ $$ ### num\_ancilla\_qubits - + The number of ancilla qubits used. **Return type** @@ -118,7 +118,7 @@ $$ ### num\_state\_qubits - + The number of qubits encoding the state for the comparison. **Return type** @@ -138,7 +138,7 @@ $$ ### prefix - + ### qregs @@ -154,7 +154,7 @@ $$ ### value - + The value to compare the qubit register to. **Return type** 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 01d0e9403c6..567f724b411 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.LinearPauliRotations.mdx @@ -46,7 +46,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. @@ -84,15 +84,15 @@ $$ ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -102,7 +102,7 @@ $$ ### num\_ancilla\_qubits - + The minimum number of ancilla qubits in the circuit. **Return type** @@ -134,7 +134,7 @@ $$ ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -148,7 +148,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. @@ -170,7 +170,7 @@ $$ ### prefix - + ### qregs @@ -186,7 +186,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.19/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.MCMT.mdx index b7f7adf2c71..44bd4949e64 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.MCMT.mdx @@ -52,15 +52,15 @@ python_api_name: qiskit.circuit.library.MCMT ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -100,7 +100,7 @@ python_api_name: qiskit.circuit.library.MCMT ### prefix - + ### qubits 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 6d86e1d5fc8..1b37f33af1d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.MCMTVChain.mdx @@ -50,15 +50,15 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -98,7 +98,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### prefix - + ### qubits 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 2b211cb4b51..cac7fe4a715 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.MSGate.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.circuit.library.MSGate ### label - + Return gate label **Return type** 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 75d97a7c850..04e79980ff2 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.NLocal.mdx @@ -89,7 +89,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.circuit.library.NLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -117,15 +117,15 @@ python_api_name: qiskit.circuit.library.NLocal ### extension\_lib - + ### header - + ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.circuit.library.NLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -153,7 +153,7 @@ python_api_name: qiskit.circuit.library.NLocal ### instances - + ### n\_qubits @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -189,7 +189,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. @@ -209,7 +209,7 @@ python_api_name: qiskit.circuit.library.NLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -223,7 +223,7 @@ python_api_name: qiskit.circuit.library.NLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -253,7 +253,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -267,7 +267,7 @@ python_api_name: qiskit.circuit.library.NLocal ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -281,7 +281,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** @@ -295,7 +295,7 @@ python_api_name: qiskit.circuit.library.NLocal ### prefix - + ### qregs @@ -311,7 +311,7 @@ python_api_name: qiskit.circuit.library.NLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -325,7 +325,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.19/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.OR.mdx index 9960cdf7190..ee4b8c3b3ed 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.OR.mdx @@ -51,15 +51,15 @@ python_api_name: qiskit.circuit.library.OR ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -93,7 +93,7 @@ python_api_name: qiskit.circuit.library.OR ### prefix - + ### qubits 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 0f4325e9982..f18aee1d1ec 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.PauliFeatureMap.mdx @@ -126,7 +126,7 @@ $$ ### entanglement - + Get the entanglement strategy. **Return type** @@ -150,11 +150,11 @@ $$ ### extension\_lib - + ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -168,11 +168,11 @@ $$ ### header - + ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -186,7 +186,7 @@ $$ ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -200,7 +200,7 @@ $$ ### instances - + ### n\_qubits @@ -216,7 +216,7 @@ $$ ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -242,7 +242,7 @@ $$ ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -256,7 +256,7 @@ $$ ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -286,7 +286,7 @@ $$ ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -300,7 +300,7 @@ $$ ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -314,7 +314,7 @@ $$ ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -328,7 +328,7 @@ $$ ### preferred\_init\_points - + The initial points for the parameters. Can be stored as initial guess in optimization. **Return type** @@ -342,7 +342,7 @@ $$ ### prefix - + ### qregs @@ -358,7 +358,7 @@ $$ ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -372,7 +372,7 @@ $$ ### rotation\_blocks - + The blocks in the rotation layers. **Return type** 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 170b60b72b7..ceff4bc3c6e 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.Permutation.mdx @@ -55,15 +55,15 @@ python_api_name: qiskit.circuit.library.Permutation ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -97,7 +97,7 @@ python_api_name: qiskit.circuit.library.Permutation ### prefix - + ### qubits 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 cc9be5b925c..3440f4f19dd 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -37,7 +37,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. @@ -53,7 +53,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)`. @@ -71,7 +71,7 @@ $$ ### contains\_zero\_breakpoint - + Whether 0 is the first breakpoint. **Return type** @@ -101,19 +101,19 @@ $$ ### extension\_lib - + ### header - + ### instances - + ### mapped\_offsets - + The offsets mapped to the internal representation. **Return type** @@ -127,7 +127,7 @@ $$ ### mapped\_slopes - + The slopes mapped to the internal representation. **Return type** @@ -147,7 +147,7 @@ $$ ### num\_ancilla\_qubits - + The number of ancilla qubits. **Return type** @@ -179,7 +179,7 @@ $$ ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -193,7 +193,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)`. @@ -211,7 +211,7 @@ $$ ### prefix - + ### qregs @@ -227,7 +227,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.19/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations.mdx index 323385337b9..44292cec92d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -45,7 +45,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. @@ -67,7 +67,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. @@ -99,7 +99,7 @@ $$ ### degree - + Return the degree of the polynomial, equals to the number of coefficients minus 1. **Return type** @@ -113,15 +113,15 @@ $$ ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -131,7 +131,7 @@ $$ ### num\_ancilla\_qubits - + The number of ancilla qubits in this circuit. **Return type** @@ -163,7 +163,7 @@ $$ ### num\_state\_qubits - + The number of state qubits representing the state $|x\rangle$. **Return type** @@ -183,7 +183,7 @@ $$ ### prefix - + ### qregs @@ -199,7 +199,7 @@ $$ ### reverse - + Whether to apply the rotations on the reversed list of qubits. **Return type** 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 3ebbbe6411f..f5c53352fef 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.QFT.mdx @@ -42,7 +42,7 @@ $$ ### approximation\_degree - + The approximation degree of the QFT. **Return type** @@ -78,7 +78,7 @@ $$ ### do\_swaps - + Whether the final swaps of the QFT are applied or not. **Return type** @@ -92,15 +92,15 @@ $$ ### extension\_lib - + ### header - + ### insert\_barriers - + Whether barriers are inserted for better visualization or not. **Return type** @@ -114,7 +114,7 @@ $$ ### instances - + ### n\_qubits @@ -136,7 +136,7 @@ $$ ### num\_qubits - + The number of qubits in the QFT circuit. **Return type** @@ -160,7 +160,7 @@ $$ ### prefix - + ### qregs 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 6e2a92134b0..f93c7e66edf 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.QuantumVolume.mdx @@ -60,15 +60,15 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -102,7 +102,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### prefix - + ### qubits 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 4e9fac5a85e..046f0d41b2d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RC3XGate.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.circuit.library.RC3XGate ### label - + Return gate label **Return type** 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 90ee8bb75d6..90e9b3f7e44 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RCCXGate.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.circuit.library.RCCXGate ### label - + Return gate label **Return type** 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 34effcbcf3e..03b5ba3c5dc 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RXGate.mdx @@ -47,7 +47,7 @@ $$ ### label - + Return gate label **Return type** 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 2aa49d010cf..bb59558babc 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RXXGate.mdx @@ -73,7 +73,7 @@ $$ ### label - + Return gate label **Return type** 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 24186fb3545..3d9e10a2ade 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RYGate.mdx @@ -47,7 +47,7 @@ $$ ### label - + Return gate label **Return type** 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 e843748303c..e5410087d70 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RYYGate.mdx @@ -73,7 +73,7 @@ $$ ### label - + Return gate label **Return type** 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 b0ee41267e3..362eb847533 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RZGate.mdx @@ -59,7 +59,7 @@ $$ ### label - + Return gate label **Return type** 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 822a01035bf..c9b6e0f3d84 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RZXGate.mdx @@ -111,7 +111,7 @@ $$ ### label - + Return gate label **Return type** 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 9f354777100..6339ce9eecf 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RZZGate.mdx @@ -85,7 +85,7 @@ $$ ### label - + Return gate label **Return type** 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 f12e2abeb7f..ad0a596456d 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.RealAmplitudes.mdx @@ -126,7 +126,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement - + Get the entanglement strategy. **Return type** @@ -140,7 +140,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -154,15 +154,15 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### extension\_lib - + ### header - + ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -176,7 +176,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -190,7 +190,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### instances - + ### n\_qubits @@ -206,7 +206,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -226,7 +226,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. @@ -246,7 +246,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -290,7 +290,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameter\_bounds - + Return the parameter bounds. **Return type** @@ -304,7 +304,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -318,7 +318,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** @@ -332,7 +332,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### prefix - + ### qregs @@ -348,7 +348,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -362,7 +362,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.19/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.SGate.mdx index fd67434e5d6..be640b84c15 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.SGate.mdx @@ -52,7 +52,7 @@ $$ ### label - + Return gate label **Return type** 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 0fbe227933d..1f42dbcb681 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.SdgGate.mdx @@ -52,7 +52,7 @@ $$ ### label - + Return gate label **Return type** 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 19925230f09..3509dba7522 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.SwapGate.mdx @@ -57,7 +57,7 @@ $$ ### label - + Return gate label **Return type** 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 004e2fef238..4c17b812f5a 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.TGate.mdx @@ -52,7 +52,7 @@ $$ ### label - + Return gate label **Return type** 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 1cffdc047b9..695577ca118 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.TdgGate.mdx @@ -52,7 +52,7 @@ $$ ### label - + Return gate label **Return type** 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 a26aeb9f26d..ddb6a7b0739 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.TwoLocal.mdx @@ -147,7 +147,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement - + Get the entanglement strategy. **Return type** @@ -161,7 +161,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### entanglement\_blocks - + The blocks in the entanglement layers. **Return type** @@ -175,15 +175,15 @@ python_api_name: qiskit.circuit.library.TwoLocal ### extension\_lib - + ### header - + ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -197,7 +197,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -211,7 +211,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### instances - + ### n\_qubits @@ -227,7 +227,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -247,7 +247,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. @@ -267,7 +267,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -281,7 +281,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -311,7 +311,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -325,7 +325,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -339,7 +339,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** @@ -353,7 +353,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### prefix - + ### qregs @@ -369,7 +369,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -383,7 +383,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.19/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.U1Gate.mdx index c3e41003ef2..265e6779387 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.U1Gate.mdx @@ -75,7 +75,7 @@ $$ ### label - + Return gate label **Return type** 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 2d27f8b3ad9..f47a3debe7b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.U2Gate.mdx @@ -63,7 +63,7 @@ $$ ### label - + Return gate label **Return type** 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 8ef07b202c8..bccdc03aaf0 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.U3Gate.mdx @@ -64,7 +64,7 @@ $$ ### label - + Return gate label **Return type** 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 7e51ace9ed1..7aa5d29f4a3 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.WeightedAdder.mdx @@ -86,15 +86,15 @@ $$ ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -104,7 +104,7 @@ $$ ### num\_ancilla\_qubits - + The number of ancilla qubits required to implement the weighted sum. **Return type** @@ -118,7 +118,7 @@ $$ ### 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`. @@ -140,7 +140,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`. @@ -168,7 +168,7 @@ $$ ### num\_state\_qubits - + The number of qubits to be summed. **Return type** @@ -182,7 +182,7 @@ $$ ### num\_sum\_qubits - + The number of sum qubits in the circuit. **Return type** @@ -202,7 +202,7 @@ $$ ### prefix - + ### qregs @@ -218,7 +218,7 @@ $$ ### weights - + The weights for the qubit states. **Return type** 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 3072d139d31..97a8eedc49e 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.XGate.mdx @@ -67,7 +67,7 @@ $$ ### label - + Return gate label **Return type** 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 768b05bcd91..e496f701961 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.XOR.mdx @@ -55,15 +55,15 @@ python_api_name: qiskit.circuit.library.XOR ### extension\_lib - + ### header - + ### instances - + ### n\_qubits @@ -97,7 +97,7 @@ python_api_name: qiskit.circuit.library.XOR ### prefix - + ### qubits 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 4a0dcec6de6..eed3dc5615c 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.YGate.mdx @@ -67,7 +67,7 @@ $$ ### label - + Return gate label **Return type** 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 66552f55722..e30f89431de 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ZFeatureMap.mdx @@ -99,7 +99,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -123,11 +123,11 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### extension\_lib - + ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -141,11 +141,11 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### header - + ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -173,7 +173,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### instances - + ### n\_qubits @@ -189,7 +189,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -215,7 +215,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -229,7 +229,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -259,7 +259,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -273,7 +273,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -287,7 +287,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -301,7 +301,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** @@ -315,7 +315,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### prefix - + ### qregs @@ -331,7 +331,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -345,7 +345,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.19/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.ZGate.mdx index fd8fcfb1747..66991662901 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ZGate.mdx @@ -67,7 +67,7 @@ $$ ### label - + Return gate label **Return type** 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 c42b7124f9c..6190bb90583 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.ZZFeatureMap.mdx @@ -86,7 +86,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### entanglement - + Get the entanglement strategy. **Return type** @@ -110,11 +110,11 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### extension\_lib - + ### feature\_dimension - + Returns the feature dimension (which is equal to the number of qubits). **Return type** @@ -128,11 +128,11 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### header - + ### initial\_state - + Return the initial state that is added in front of the n-local circuit. **Return type** @@ -146,7 +146,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### insert\_barriers - + If barriers are inserted in between the layers or not. **Return type** @@ -160,7 +160,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### instances - + ### n\_qubits @@ -176,7 +176,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_layers - + Return the number of layers in the n-local circuit. **Return type** @@ -202,7 +202,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### num\_qubits - + Returns the number of qubits in this circuit. **Return type** @@ -216,7 +216,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### ordered\_parameters - + The parameters used in the underlying circuit. This includes float values and duplicates. @@ -246,7 +246,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameter\_bounds - + The parameter bounds for the unbound parameters in the circuit. **Return type** @@ -260,7 +260,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### parameters - + Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -274,7 +274,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### paulis - + The Pauli strings used in the entanglement of the qubits. **Return type** @@ -288,7 +288,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** @@ -302,7 +302,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### prefix - + ### qregs @@ -318,7 +318,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### reps - + The number of times rotation and entanglement block are repeated. **Return type** @@ -332,7 +332,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.19/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/0.19/qiskit.circuit.library.iSwapGate.mdx index ad35ea32e11..4aa44cd476b 100644 --- a/docs/api/qiskit/0.19/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.circuit.library.iSwapGate.mdx @@ -80,7 +80,7 @@ $$ ### label - + Return gate label **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.mdx b/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.mdx index 26234969b0f..3d4a8a7ccf0 100644 --- a/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.extensions.HamiltonianGate.mdx @@ -39,7 +39,7 @@ python_api_name: qiskit.extensions.HamiltonianGate ### label - + Return gate label **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.mdx b/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.mdx index 488d7eb01d4..ad18fced8a9 100644 --- a/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.mdx +++ b/docs/api/qiskit/0.19/qiskit.extensions.UnitaryGate.mdx @@ -38,7 +38,7 @@ python_api_name: qiskit.extensions.UnitaryGate ### label - + Return gate label **Return type** 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 a28762d9d50..3e0304cb034 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 @@ -15,18 +15,18 @@ python_api_name: qiskit.finance.data_providers.DataType ### ASK - + ### BID - + ### DAILY - + ### DAILYADJUSTED - + 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 2ac4c9c8af1..8d4efebf38c 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 @@ -15,26 +15,26 @@ python_api_name: qiskit.finance.data_providers.StockMarket ### EURONEXT - + ### LONDON - + ### NASDAQ - + ### NYSE - + ### RANDOM - + ### SINGAPORE - + 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 f4a25614571..b0643c7c56b 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalCXFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalCXFitter.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -37,7 +37,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** @@ -47,7 +47,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -87,7 +87,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** @@ -97,7 +97,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.19/qiskit.ignis.characterization.AmpCalFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalFitter.mdx index 51f480f4b8b..c1fe7daad2d 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AmpCalFitter.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### backend\_result - + Return the execution results **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -37,7 +37,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** @@ -47,7 +47,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.ignis.characterization.AmpCalFitter ### series - + Return the list of series for the data **Return type** @@ -87,7 +87,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** @@ -97,7 +97,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.19/qiskit.ignis.characterization.AngleCalCXFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalCXFitter.mdx index 099aa3a4059..297fa0c4ed4 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalCXFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalCXFitter.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### backend\_result - + Return the execution results **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -37,7 +37,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** @@ -47,7 +47,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalCXFitter ### series - + Return the list of series for the data **Return type** @@ -87,7 +87,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** @@ -97,7 +97,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.19/qiskit.ignis.characterization.AngleCalFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalFitter.mdx index 92c041d0b0e..7313acf6d4a 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.AngleCalFitter.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### backend\_result - + Return the execution results **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -37,7 +37,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** @@ -47,7 +47,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.ignis.characterization.AngleCalFitter ### series - + Return the list of series for the data **Return type** @@ -87,7 +87,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** @@ -97,7 +97,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.19/qiskit.ignis.characterization.BaseCoherenceFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseCoherenceFitter.mdx index bcdb785f682..2a7320e25b7 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseCoherenceFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseCoherenceFitter.mdx @@ -30,7 +30,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### backend\_result - + Return the execution results **Return type** @@ -40,7 +40,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -50,7 +50,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** @@ -60,7 +60,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -70,7 +70,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter ### series - + Return the list of series for the data **Return type** @@ -100,7 +100,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** @@ -110,7 +110,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.19/qiskit.ignis.characterization.BaseGateFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseGateFitter.mdx index 373227dd407..99b6d1df94b 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseGateFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.BaseGateFitter.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### backend\_result - + Return the execution results **Return type** @@ -27,7 +27,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -37,7 +37,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** @@ -47,7 +47,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.ignis.characterization.BaseGateFitter ### series - + Return the list of series for the data **Return type** @@ -87,7 +87,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** @@ -97,7 +97,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.19/qiskit.ignis.characterization.DragFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.DragFitter.mdx index d458166153c..bc38d2496f3 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.DragFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.DragFitter.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### backend\_result - + Return the execution results **Return type** @@ -29,7 +29,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -39,7 +39,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** @@ -49,7 +49,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.ignis.characterization.DragFitter ### series - + Return the list of series for the data **Return type** @@ -89,7 +89,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** @@ -99,7 +99,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.19/qiskit.ignis.characterization.RabiFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.RabiFitter.mdx index 298de08154b..7cf72d52c3a 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.RabiFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.RabiFitter.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### backend\_result - + Return the execution results **Return type** @@ -29,7 +29,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -39,7 +39,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** @@ -49,7 +49,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.ignis.characterization.RabiFitter ### series - + Return the list of series for the data **Return type** @@ -89,7 +89,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** @@ -99,7 +99,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.19/qiskit.ignis.characterization.T1Fitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T1Fitter.mdx index ca6f8afd933..dbae1c5d616 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T1Fitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T1Fitter.mdx @@ -34,7 +34,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -44,7 +44,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -54,7 +54,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -64,7 +64,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -74,7 +74,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -84,7 +84,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -94,7 +94,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -104,7 +104,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -114,7 +114,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.19/qiskit.ignis.characterization.T2Fitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2Fitter.mdx index 1678f26ffb1..a16a1adcc8a 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2Fitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2Fitter.mdx @@ -35,7 +35,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -45,7 +45,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -55,7 +55,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -65,7 +65,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -75,7 +75,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -85,7 +85,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -95,7 +95,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -105,7 +105,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -115,7 +115,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.19/qiskit.ignis.characterization.T2StarFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2StarFitter.mdx index 9998487ee54..377dbe7c933 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2StarFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.T2StarFitter.mdx @@ -34,7 +34,7 @@ $$ ### backend\_result - + Return the execution results **Return type** @@ -44,7 +44,7 @@ $$ ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -54,7 +54,7 @@ $$ ### fit\_fun - + Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun **Return type** @@ -64,7 +64,7 @@ $$ ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -74,7 +74,7 @@ $$ ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -84,7 +84,7 @@ $$ ### params\_err - + Return the error of the fit function parameters **Return type** @@ -94,7 +94,7 @@ $$ ### series - + Return the list of series for the data **Return type** @@ -104,7 +104,7 @@ $$ ### xdata - + Return the data points on the x-axis, the independenet parameter which is fit against **Return type** @@ -114,7 +114,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.19/qiskit.ignis.characterization.ZZFitter.mdx b/docs/api/qiskit/0.19/qiskit.ignis.characterization.ZZFitter.mdx index 4d5c268bfa4..c67e04d6922 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.characterization.ZZFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.characterization.ZZFitter.mdx @@ -15,7 +15,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### backend\_result - + Return the execution results **Return type** @@ -25,7 +25,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### description - + Return the fitter’s purpose, e.g. ‘T1’ **Return type** @@ -35,7 +35,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** @@ -45,7 +45,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### measured\_qubits - + Return the indices of the qubits to be characterized **Return type** @@ -55,7 +55,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params - + Return the fit function parameters that were calculated by curve\_fit **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### params\_err - + Return the error of the fit function parameters **Return type** @@ -75,7 +75,7 @@ python_api_name: qiskit.ignis.characterization.ZZFitter ### series - + Return the list of series for the data **Return type** @@ -85,7 +85,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** @@ -95,7 +95,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.19/qiskit.ignis.logging.IgnisLogger.mdx b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogger.mdx index 4d6c6616f31..f9c0e8cc896 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogger.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.logging.IgnisLogger.mdx @@ -26,11 +26,11 @@ python_api_name: qiskit.ignis.logging.IgnisLogger ### manager - + ### root - + ## Methods 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 b6dd62a2fed..850ed829034 100644 --- a/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationFitter.mdx +++ b/docs/api/qiskit/0.19/qiskit.ignis.verification.AccreditationFitter.mdx @@ -17,35 +17,35 @@ python_api_name: qiskit.ignis.verification.AccreditationFitter ### N\_acc - + ### bound - + ### confidence - + ### flag - + ### g\_num - + ### num\_runs - + ### num\_traps - + ### outputs - + ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.mdx b/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.mdx index 7aa0931a6d1..16b7314d56d 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.QuadraticProgram.mdx @@ -21,7 +21,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -35,7 +35,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** @@ -49,7 +49,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -91,7 +91,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** @@ -105,7 +105,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.optimization.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -133,7 +133,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.19/qiskit.optimization.algorithms.CplexOptimizer.mdx b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CplexOptimizer.mdx index 3f2e3ceb26a..3791c51a3cb 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CplexOptimizer.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.CplexOptimizer.mdx @@ -38,7 +38,7 @@ python_api_name: qiskit.optimization.algorithms.CplexOptimizer ### disp - + Returns the display setting. **Return type** 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 6e1631524fd..4ef7057ab55 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.algorithms.GroverOptimizer.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.algorithms.GroverOptimizer.mdx @@ -21,7 +21,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.19/qiskit.optimization.problems.Constraint.mdx b/docs/api/qiskit/0.19/qiskit.optimization.problems.Constraint.mdx index a9704b5a7dc..1696fbc8868 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.Constraint.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.Constraint.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### name - + Returns the name of the constraint. **Return type** @@ -38,7 +38,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -52,7 +52,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -66,7 +66,7 @@ python_api_name: qiskit.optimization.problems.Constraint ### sense - + Returns the sense of the constraint. **Return type** 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 1351db32d74..c0dde088c1e 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearConstraint.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearConstraint.mdx @@ -23,7 +23,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -37,7 +37,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### name - + Returns the name of the constraint. **Return type** @@ -51,7 +51,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -65,7 +65,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.optimization.problems.LinearConstraint ### sense - + Returns the sense of the constraint. **Return type** 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 e8f6efd3421..6150b265adb 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearExpression.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.LinearExpression.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### coefficients - + Returns the coefficients of the linear expression. **Return type** @@ -38,7 +38,7 @@ python_api_name: qiskit.optimization.problems.LinearExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** 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 4d43b25b287..e0f53ed6a13 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticConstraint.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticConstraint.mdx @@ -26,7 +26,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### linear - + Returns the linear expression corresponding to the left-hand-side of the constraint. **Return type** @@ -40,7 +40,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### name - + Returns the name of the constraint. **Return type** @@ -54,7 +54,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic - + Returns the quadratic expression corresponding to the left-hand-side of the constraint. **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -82,7 +82,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### rhs - + Returns the right-hand-side of the constraint. **Return type** @@ -96,7 +96,7 @@ python_api_name: qiskit.optimization.problems.QuadraticConstraint ### sense - + Returns the sense of the constraint. **Return type** 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 56fb7af83a9..88968b4bebd 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticExpression.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticExpression.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### coefficients - + Returns the coefficients of the quadratic expression. **Return type** @@ -38,7 +38,7 @@ python_api_name: qiskit.optimization.problems.QuadraticExpression ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** 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 b38f93e48d8..7a19e4a4562 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticObjective.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticObjective.mdx @@ -25,7 +25,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### constant - + Returns the constant part of the objective function. **Return type** @@ -39,7 +39,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### linear - + Returns the linear part of the objective function. **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic - + Returns the quadratic part of the objective function. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.optimization.problems.QuadraticObjective ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -81,7 +81,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.19/qiskit.optimization.problems.QuadraticProgram.mdx b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticProgram.mdx index b950998ec55..5d1edd422d3 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticProgram.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.QuadraticProgram.mdx @@ -21,7 +21,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### linear\_constraints - + Returns the list of linear constraints of the quadratic program. **Return type** @@ -35,7 +35,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** @@ -49,7 +49,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### name - + Returns the name of the quadratic program. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### objective - + Returns the quadratic objective. **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### quadratic\_constraints - + Returns the list of quadratic constraints of the quadratic program. **Return type** @@ -91,7 +91,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** @@ -105,7 +105,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### status - + Status of the quadratic program. It can be infeasible due to variable substitution. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.optimization.problems.QuadraticProgram ### variables - + Returns the list of variables of the quadratic program. **Return type** @@ -133,7 +133,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.19/qiskit.optimization.problems.Variable.mdx b/docs/api/qiskit/0.19/qiskit.optimization.problems.Variable.mdx index 33b17781404..6d74515b7ef 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.problems.Variable.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.problems.Variable.mdx @@ -31,7 +31,7 @@ python_api_name: qiskit.optimization.problems.Variable ### lowerbound - + Returns the lowerbound of the variable. **Return type** @@ -45,7 +45,7 @@ python_api_name: qiskit.optimization.problems.Variable ### name - + Returns the name of the variable. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.optimization.problems.Variable ### quadratic\_program - + Returns the parent QuadraticProgram. **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.optimization.problems.Variable ### upperbound - + Returns the upperbound of the variable. **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.optimization.problems.Variable ### vartype - + Returns the type of the variable. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/0.19/qiskit.providers.JobStatus.mdx index cd42f36a9cb..317e8b80c74 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.JobStatus.mdx @@ -15,30 +15,30 @@ python_api_name: qiskit.providers.JobStatus ### CANCELLED - + ### DONE - + ### ERROR - + ### INITIALIZING - + ### QUEUED - + ### RUNNING - + ### VALIDATING - + 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 c46c50150d1..bd4bc0a0d1e 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.PulseSimulator.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.PulseSimulator.mdx @@ -63,7 +63,7 @@ python_api_name: qiskit.providers.aer.PulseSimulator ### DEFAULT\_CONFIGURATION - + ## Methods 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 846e3fd17c2..94167f1a372 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.QasmSimulator.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.QasmSimulator.mdx @@ -99,11 +99,11 @@ python_api_name: qiskit.providers.aer.QasmSimulator ### DEFAULT\_CONFIGURATION - + ### MAX\_QUBIT\_MEMORY - + ## Methods 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 e21d8a2ae94..dc3a26426f0 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.StatevectorSimulator.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.StatevectorSimulator.mdx @@ -41,11 +41,11 @@ python_api_name: qiskit.providers.aer.StatevectorSimulator ### DEFAULT\_CONFIGURATION - + ### MAX\_QUBIT\_MEMORY - + ## Methods 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 1445658fdc5..b2aea1b22c7 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.aer.UnitarySimulator.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.aer.UnitarySimulator.mdx @@ -42,11 +42,11 @@ python_api_name: qiskit.providers.aer.UnitarySimulator ### DEFAULT\_CONFIGURATION - + ### MAX\_QUBIT\_MEMORY - + ## 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 99b7f88ed92..81971329df0 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.QasmSimulatorPy.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.QasmSimulatorPy.mdx @@ -28,19 +28,19 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy ### DEFAULT\_CONFIGURATION - + ### DEFAULT\_OPTIONS - + ### MAX\_QUBITS\_MEMORY - + ### SHOW\_FINAL\_STATE - + ## Methods 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 d150603ef06..32710eec753 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.StatevectorSimulatorPy.mdx @@ -28,19 +28,19 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy ### DEFAULT\_CONFIGURATION - + ### DEFAULT\_OPTIONS - + ### MAX\_QUBITS\_MEMORY - + ### SHOW\_FINAL\_STATE - + ## Methods 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 f0bedaeb9f5..747903954fb 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.basicaer.UnitarySimulatorPy.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.basicaer.UnitarySimulatorPy.mdx @@ -28,15 +28,15 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy ### DEFAULT\_CONFIGURATION - + ### DEFAULT\_OPTIONS - + ### MAX\_QUBITS\_MEMORY - + ## Methods 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 967bf26ee2a..b9dabac6f97 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.BackendStatus.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.BackendStatus.mdx @@ -29,7 +29,7 @@ python_api_name: qiskit.providers.models.BackendStatus ### version\_regex - + ## Methods 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 c64bc7a9486..585383e67de 100644 --- a/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/0.19/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -67,7 +67,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.19/qiskit.pulse.Acquire.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Acquire.mdx index d0f90a9dd7c..83b763be6cf 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Acquire.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Acquire.mdx @@ -39,7 +39,7 @@ python_api_name: qiskit.pulse.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -49,7 +49,7 @@ python_api_name: qiskit.pulse.Acquire ### acquires - + Acquire channels to be acquired on. **Return type** @@ -59,7 +59,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** @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.Acquire ### channels - + Returns channels that this schedule uses. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.pulse.Acquire ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.Acquire ### duration - + Duration of this instruction. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.pulse.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.pulse.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.pulse.Acquire ### kernel - + Return kernel settings. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.pulse.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.pulse.Acquire ### mem\_slots - + MemorySlots. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.pulse.Acquire ### name - + Name of this instruction. **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.pulse.Acquire ### operands - + Return instruction operands. **Return type** @@ -179,7 +179,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** @@ -189,7 +189,7 @@ python_api_name: qiskit.pulse.Acquire ### reg\_slots - + RegisterSlots. **Return type** @@ -199,7 +199,7 @@ python_api_name: qiskit.pulse.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -209,7 +209,7 @@ python_api_name: qiskit.pulse.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** @@ -219,7 +219,7 @@ python_api_name: qiskit.pulse.Acquire ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.mdx b/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.mdx index a708fe38091..72267270b2b 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.AcquireChannel.mdx @@ -25,7 +25,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** @@ -35,7 +35,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** @@ -45,7 +45,7 @@ python_api_name: qiskit.pulse.AcquireChannel ### prefix - + A shorthand string prefix for characterizing the channel type. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Constant.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Constant.mdx index f1814c8bfb0..59160c46733 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Constant.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Constant.mdx @@ -28,7 +28,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -38,7 +38,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -48,7 +48,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.mdx b/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.mdx index ae1385e8b4c..80140cc1ff2 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.ControlChannel.mdx @@ -25,7 +25,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** @@ -35,7 +35,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** @@ -45,7 +45,7 @@ python_api_name: qiskit.pulse.ControlChannel ### prefix - + A shorthand string prefix for characterizing the channel type. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Delay.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Delay.mdx index 8d9aaec222c..66d60ab00dd 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Delay.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Delay.mdx @@ -37,7 +37,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** @@ -47,7 +47,7 @@ python_api_name: qiskit.pulse.Delay ### channels - + Returns channels that this schedule uses. **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.pulse.Delay ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.pulse.Delay ### duration - + Duration of this instruction. **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.pulse.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.pulse.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.pulse.Delay ### name - + Name of this instruction. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.pulse.Delay ### operands - + Return instruction operands. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.pulse.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.pulse.Delay ### stop\_time - + Relative end time of this instruction. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.pulse.Delay ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Drag.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Drag.mdx index f108fbb2d4d..75c39114ac6 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Drag.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Drag.mdx @@ -42,7 +42,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -52,7 +52,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -62,7 +62,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -72,7 +72,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -82,7 +82,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.mdx b/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.mdx index 460e5991cfe..77c952d2ac8 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.DriveChannel.mdx @@ -25,7 +25,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** @@ -35,7 +35,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** @@ -45,7 +45,7 @@ python_api_name: qiskit.pulse.DriveChannel ### prefix - + A shorthand string prefix for characterizing the channel type. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.mdx index e90877b8522..14cf0b6a6ed 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Gaussian.mdx @@ -28,7 +28,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -38,7 +38,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -48,7 +48,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -58,7 +58,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.mdx b/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.mdx index 1b2cbccd396..8096f70c683 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.GaussianSquare.mdx @@ -29,7 +29,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -39,7 +39,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -49,7 +49,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -59,7 +59,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -69,7 +69,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Instruction.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Instruction.mdx index afbd85b148e..94dbf346f8c 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Instruction.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Instruction.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.pulse.Instruction ### channels - + Returns channels that this schedule uses. **Return type** @@ -38,7 +38,7 @@ python_api_name: qiskit.pulse.Instruction ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -48,7 +48,7 @@ python_api_name: qiskit.pulse.Instruction ### duration - + Duration of this instruction. **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.pulse.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.pulse.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.pulse.Instruction ### name - + Name of this instruction. **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.pulse.Instruction ### operands - + Return instruction operands. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.pulse.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.pulse.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.pulse.Instruction ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.mdx index 75317a7d5fd..14d4b96590f 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.InstructionScheduleMap.mdx @@ -25,7 +25,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.19/qiskit.pulse.MeasureChannel.mdx b/docs/api/qiskit/0.19/qiskit.pulse.MeasureChannel.mdx index bfc4fe79ba4..7e9316070e3 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.MeasureChannel.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.MeasureChannel.mdx @@ -25,7 +25,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** @@ -35,7 +35,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** @@ -45,7 +45,7 @@ python_api_name: qiskit.pulse.MeasureChannel ### prefix - + A shorthand string prefix for characterizing the channel type. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.mdx b/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.mdx index 9476d037882..6da531bbf58 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.MemorySlot.mdx @@ -25,7 +25,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** @@ -35,7 +35,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** @@ -45,7 +45,7 @@ python_api_name: qiskit.pulse.MemorySlot ### prefix - + A shorthand string prefix for characterizing the channel type. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Play.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Play.mdx index 22a305651ff..f9acc90d651 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Play.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Play.mdx @@ -29,7 +29,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** @@ -39,7 +39,7 @@ python_api_name: qiskit.pulse.Play ### channels - + Returns channels that this schedule uses. **Return type** @@ -49,7 +49,7 @@ python_api_name: qiskit.pulse.Play ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.pulse.Play ### duration - + Duration of this instruction. **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.Play ### id - + Unique identifier for this instruction. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.pulse.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.Play ### name - + Name of this instruction. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.Play ### operands - + Return instruction operands. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.pulse.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.pulse.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.pulse.Play ### stop\_time - + Relative end time of this instruction. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.pulse.Play ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.mdx b/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.mdx index 879ccc291a9..2c484110432 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.RegisterSlot.mdx @@ -25,7 +25,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** @@ -35,7 +35,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** @@ -45,7 +45,7 @@ python_api_name: qiskit.pulse.RegisterSlot ### prefix - + A shorthand string prefix for characterizing the channel type. diff --git a/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.mdx b/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.mdx index 356c8e3d049..749642ba878 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.SamplePulse.mdx @@ -23,7 +23,7 @@ python_api_name: qiskit.pulse.SamplePulse ### id - + Unique identifier for this pulse. **Return type** @@ -33,7 +33,7 @@ python_api_name: qiskit.pulse.SamplePulse ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Schedule.mdx index e5bc1d3ceda..4683401271e 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Schedule.mdx @@ -22,7 +22,7 @@ python_api_name: qiskit.pulse.Schedule ### channels - + Returns channels that this schedule uses. **Return type** @@ -32,7 +32,7 @@ python_api_name: qiskit.pulse.Schedule ### duration - + Duration of this schedule component. **Return type** @@ -42,7 +42,7 @@ python_api_name: qiskit.pulse.Schedule ### instances\_counter - + ### instructions @@ -56,7 +56,7 @@ python_api_name: qiskit.pulse.Schedule ### name - + Name of ScheduleComponent. **Return type** @@ -66,11 +66,11 @@ python_api_name: qiskit.pulse.Schedule ### prefix - + ### start\_time - + Starting time of this schedule component. **Return type** @@ -80,7 +80,7 @@ python_api_name: qiskit.pulse.Schedule ### stop\_time - + Stopping time of this schedule component. **Return type** @@ -90,7 +90,7 @@ python_api_name: qiskit.pulse.Schedule ### timeslots - + Time keeping attribute. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.mdx b/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.mdx index df1469638ea..462c1f7edde 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.SetFrequency.mdx @@ -31,7 +31,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -41,7 +41,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -51,7 +51,7 @@ $$ ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -61,7 +61,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -71,7 +71,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -81,7 +81,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -91,7 +91,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -101,7 +101,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -111,7 +111,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -121,7 +121,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -131,7 +131,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** @@ -141,7 +141,7 @@ $$ ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.mdx b/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.mdx index c8495dba364..5a680d4ea47 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.ShiftPhase.mdx @@ -33,7 +33,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -43,7 +43,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -53,7 +53,7 @@ $$ ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -63,7 +63,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -73,7 +73,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -83,7 +83,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -93,7 +93,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -103,7 +103,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -113,7 +113,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -123,7 +123,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -133,7 +133,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** @@ -143,7 +143,7 @@ $$ ### timeslots - + Occupied time slots by this instruction. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.mdx b/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.mdx index 0699ade9a51..46247000c50 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.Snapshot.mdx @@ -23,7 +23,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** @@ -33,7 +33,7 @@ python_api_name: qiskit.pulse.Snapshot ### channels - + Returns channels that this schedule uses. **Return type** @@ -43,7 +43,7 @@ python_api_name: qiskit.pulse.Snapshot ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.pulse.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.pulse.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.pulse.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.pulse.Snapshot ### label - + Label of snapshot. **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.pulse.Snapshot ### name - + Name of this instruction. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.pulse.Snapshot ### operands - + Return instruction operands. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.pulse.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.pulse.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -133,7 +133,7 @@ python_api_name: qiskit.pulse.Snapshot ### timeslots - + Occupied time slots by this instruction. **Return type** @@ -143,7 +143,7 @@ python_api_name: qiskit.pulse.Snapshot ### type - + Type of snapshot. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.pulse.channels.mdx b/docs/api/qiskit/0.19/qiskit.pulse.channels.mdx index 2c8d9a126c6..8d495d0c22d 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.channels.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.channels.mdx @@ -45,7 +45,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** @@ -55,7 +55,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** @@ -79,7 +79,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** @@ -89,7 +89,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** @@ -119,7 +119,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** @@ -129,7 +129,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** @@ -153,7 +153,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** @@ -163,7 +163,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** @@ -187,7 +187,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** @@ -197,7 +197,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** @@ -221,7 +221,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** @@ -231,7 +231,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** @@ -255,7 +255,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** @@ -265,7 +265,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** @@ -289,7 +289,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** @@ -299,7 +299,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** @@ -315,7 +315,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** @@ -325,7 +325,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.19/qiskit.pulse.instructions.Acquire.mdx b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.mdx index 84083812492..b947e6ea3bd 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Acquire.mdx @@ -39,7 +39,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### acquire - + Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qubit index. **Return type** @@ -49,7 +49,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### acquires - + Acquire channels to be acquired on. **Return type** @@ -59,7 +59,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** @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### channels - + Returns channels that this schedule uses. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### discriminator - + Return discrimination settings. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### duration - + Duration of this instruction. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### id - + Unique identifier for this instruction. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### kernel - + Return kernel settings. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### mem\_slot - + The classical memory slot which will store the classified readout result. **Return type** @@ -149,7 +149,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### mem\_slots - + MemorySlots. **Return type** @@ -159,7 +159,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### name - + Name of this instruction. **Return type** @@ -169,7 +169,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### operands - + Return instruction operands. **Return type** @@ -179,7 +179,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** @@ -189,7 +189,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### reg\_slots - + RegisterSlots. **Return type** @@ -199,7 +199,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### start\_time - + Relative begin time of this instruction. **Return type** @@ -209,7 +209,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### stop\_time - + Relative end time of this instruction. **Return type** @@ -219,7 +219,7 @@ python_api_name: qiskit.pulse.instructions.Acquire ### timeslots - + Occupied time slots by this instruction. **Return type** 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 6d27c373c95..38713ada8ee 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Delay.mdx @@ -37,7 +37,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** @@ -47,7 +47,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### channels - + Returns channels that this schedule uses. **Return type** @@ -57,7 +57,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -67,7 +67,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### duration - + Duration of this instruction. **Return type** @@ -77,7 +77,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### id - + Unique identifier for this instruction. **Return type** @@ -87,7 +87,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -97,7 +97,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### name - + Name of this instruction. **Return type** @@ -107,7 +107,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### operands - + Return instruction operands. **Return type** @@ -117,7 +117,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### start\_time - + Relative begin time of this instruction. **Return type** @@ -127,7 +127,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### stop\_time - + Relative end time of this instruction. **Return type** @@ -137,7 +137,7 @@ python_api_name: qiskit.pulse.instructions.Delay ### timeslots - + Occupied time slots by this instruction. **Return type** 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 20342d5f0c9..bf073c34fa8 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Instruction.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### channels - + Returns channels that this schedule uses. **Return type** @@ -38,7 +38,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -48,7 +48,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### duration - + Duration of this instruction. **Return type** @@ -58,7 +58,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### id - + Unique identifier for this instruction. **Return type** @@ -68,7 +68,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -78,7 +78,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### name - + Name of this instruction. **Return type** @@ -88,7 +88,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### operands - + Return instruction operands. **Return type** @@ -98,7 +98,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### start\_time - + Relative begin time of this instruction. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### stop\_time - + Relative end time of this instruction. **Return type** @@ -118,7 +118,7 @@ python_api_name: qiskit.pulse.instructions.Instruction ### timeslots - + Occupied time slots by this instruction. **Return type** 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 3bf0145652a..3a08b069358 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Play.mdx @@ -29,7 +29,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** @@ -39,7 +39,7 @@ python_api_name: qiskit.pulse.instructions.Play ### channels - + Returns channels that this schedule uses. **Return type** @@ -49,7 +49,7 @@ python_api_name: qiskit.pulse.instructions.Play ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -59,7 +59,7 @@ python_api_name: qiskit.pulse.instructions.Play ### duration - + Duration of this instruction. **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.pulse.instructions.Play ### id - + Unique identifier for this instruction. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.pulse.instructions.Play ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -89,7 +89,7 @@ python_api_name: qiskit.pulse.instructions.Play ### name - + Name of this instruction. **Return type** @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.instructions.Play ### operands - + Return instruction operands. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.pulse.instructions.Play ### pulse - + A description of the samples that will be played. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.pulse.instructions.Play ### start\_time - + Relative begin time of this instruction. **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit.pulse.instructions.Play ### stop\_time - + Relative end time of this instruction. **Return type** @@ -139,7 +139,7 @@ python_api_name: qiskit.pulse.instructions.Play ### timeslots - + Occupied time slots by this instruction. **Return type** 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 844bcbc6f6d..45dc9cfa8cb 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.SetFrequency.mdx @@ -31,7 +31,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -41,7 +41,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -51,7 +51,7 @@ $$ ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -61,7 +61,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -71,7 +71,7 @@ $$ ### frequency - + New frequency. **Return type** @@ -81,7 +81,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -91,7 +91,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -101,7 +101,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -111,7 +111,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -121,7 +121,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -131,7 +131,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** @@ -141,7 +141,7 @@ $$ ### timeslots - + Occupied time slots by this instruction. **Return type** 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 e0ce91eb00a..4f9281b34bd 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.ShiftPhase.mdx @@ -33,7 +33,7 @@ $$ ### channel - + Return the [`Channel`](qiskit.pulse.channels#channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on. **Return type** @@ -43,7 +43,7 @@ $$ ### channels - + Returns channels that this schedule uses. **Return type** @@ -53,7 +53,7 @@ $$ ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -63,7 +63,7 @@ $$ ### duration - + Duration of this instruction. **Return type** @@ -73,7 +73,7 @@ $$ ### id - + Unique identifier for this instruction. **Return type** @@ -83,7 +83,7 @@ $$ ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -93,7 +93,7 @@ $$ ### name - + Name of this instruction. **Return type** @@ -103,7 +103,7 @@ $$ ### operands - + Return instruction operands. **Return type** @@ -113,7 +113,7 @@ $$ ### phase - + Return the rotation angle enacted by this instruction in radians. **Return type** @@ -123,7 +123,7 @@ $$ ### start\_time - + Relative begin time of this instruction. **Return type** @@ -133,7 +133,7 @@ $$ ### stop\_time - + Relative end time of this instruction. **Return type** @@ -143,7 +143,7 @@ $$ ### timeslots - + Occupied time slots by this instruction. **Return type** 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 c3c719a1e61..14d1e439fe4 100644 --- a/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.mdx +++ b/docs/api/qiskit/0.19/qiskit.pulse.instructions.Snapshot.mdx @@ -23,7 +23,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** @@ -33,7 +33,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### channels - + Returns channels that this schedule uses. **Return type** @@ -43,7 +43,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### command - + The associated command. Commands are deprecated, so this method will be deprecated shortly. **Return type** @@ -53,7 +53,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### duration - + Duration of this instruction. **Return type** @@ -63,7 +63,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### id - + Unique identifier for this instruction. **Return type** @@ -73,7 +73,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### instructions - + Iterable for getting instructions from Schedule tree. **Return type** @@ -83,7 +83,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### label - + Label of snapshot. **Return type** @@ -93,7 +93,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### name - + Name of this instruction. **Return type** @@ -103,7 +103,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### operands - + Return instruction operands. **Return type** @@ -113,7 +113,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### start\_time - + Relative begin time of this instruction. **Return type** @@ -123,7 +123,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### stop\_time - + Relative end time of this instruction. **Return type** @@ -133,7 +133,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### timeslots - + Occupied time slots by this instruction. **Return type** @@ -143,7 +143,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot ### type - + Type of snapshot. **Return type** 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 9a0b4f2bd78..f543301eaa9 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 @@ -28,7 +28,7 @@ $$ ### amp - + The constant value amplitude. **Return type** @@ -38,7 +38,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -48,7 +48,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** 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 1ffaf688ff7..50a119731dc 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 @@ -42,7 +42,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -52,7 +52,7 @@ $$ ### beta - + The weighing factor for the Gaussian derivative component of the waveform. **Return type** @@ -62,7 +62,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -72,7 +72,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -82,7 +82,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** 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 04ec59d102c..3027e099d8a 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 @@ -28,7 +28,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -38,7 +38,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -48,7 +48,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -58,7 +58,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** 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 f9c9e24f5c4..28c0abceeea 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 @@ -29,7 +29,7 @@ $$ ### amp - + The Gaussian amplitude. **Return type** @@ -39,7 +39,7 @@ $$ ### id - + Unique identifier for this pulse. **Return type** @@ -49,7 +49,7 @@ $$ ### parameters - + Return a dictionary containing the pulse’s parameters. **Return type** @@ -59,7 +59,7 @@ $$ ### sigma - + The Gaussian standard deviation of the pulse width. **Return type** @@ -69,7 +69,7 @@ $$ ### width - + The width of the square portion of the pulse. **Return type** 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 ffde56a7011..ccb57f895b0 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 @@ -23,7 +23,7 @@ python_api_name: qiskit.pulse.pulse_lib.SamplePulse ### id - + Unique identifier for this pulse. **Return type** @@ -33,7 +33,7 @@ python_api_name: qiskit.pulse.pulse_lib.SamplePulse ### samples - + Return sample values. **Return type** diff --git a/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.mdx b/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.mdx index 778a747b662..e0d4bef0cff 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.mdx +++ b/docs/api/qiskit/0.19/qiskit.qasm.OpenQASMLexer.mdx @@ -15,53 +15,53 @@ python_api_name: qiskit.qasm.OpenQASMLexer ### alias\_filenames - + Secondary file name globs ### aliases - + Shortcuts for the lexer ### filenames - + File name globs ### flags - + Flags for compiling the regular expressions. Defaults to MULTILINE. ### gates - + ### mimetypes - + MIME types ### name - + Name of the lexer ### priority - + Priority, should multiple lexers match and no content is provided ### tokens - + Dict of `{'state': [(regex, tokentype, new_state), ...], ...}` The initial state is ‘root’. `new_state` can be omitted to signify no state transition. If it is a string, the state is pushed on the stack and changed. If it is a tuple of strings, all states are pushed on the stack and the current state will be the topmost. It can also be `combined('state1', 'state2', ...)` to signify a new, anonymous state combined from the rules of two or more existing ones. Furthermore, it can be ‘#pop’ to signify going back one step in the state stack, or ‘#push’ to push the current state on the stack again. diff --git a/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.mdx b/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.mdx index fe811b59274..f54267f14b9 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.mdx +++ b/docs/api/qiskit/0.19/qiskit.qasm.QasmHTMLStyle.mdx @@ -15,43 +15,43 @@ python_api_name: qiskit.qasm.QasmHTMLStyle ### background\_color - + overall background color (`None` means transparent) ### highlight\_color - + highlight background color ### line\_number\_background\_color - + line number background color ### line\_number\_color - + line number font color ### line\_number\_special\_background\_color - + special line number background color ### line\_number\_special\_color - + special line number font color ### styles - + Style definitions for individual token types. diff --git a/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.mdx b/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.mdx index a1f9aea8cd0..edd7f3661f4 100644 --- a/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.mdx +++ b/docs/api/qiskit/0.19/qiskit.qasm.QasmTerminalStyle.mdx @@ -15,43 +15,43 @@ python_api_name: qiskit.qasm.QasmTerminalStyle ### background\_color - + overall background color (`None` means transparent) ### highlight\_color - + highlight background color ### line\_number\_background\_color - + line number background color ### line\_number\_color - + line number font color ### line\_number\_special\_background\_color - + special line number background color ### line\_number\_special\_color - + special line number font color ### styles - + Style definitions for individual token types. diff --git a/docs/api/qiskit/0.19/qiskit.result.Result.mdx b/docs/api/qiskit/0.19/qiskit.result.Result.mdx index f2b5044f208..9d70816a483 100644 --- a/docs/api/qiskit/0.19/qiskit.result.Result.mdx +++ b/docs/api/qiskit/0.19/qiskit.result.Result.mdx @@ -83,11 +83,11 @@ python_api_name: qiskit.result.Result ### schema - + ### shallow\_schema - + ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.mdx b/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.mdx index 1eb0893ebbd..5f83ec0dfee 100644 --- a/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.mdx +++ b/docs/api/qiskit/0.19/qiskit.transpiler.FlowController.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.FlowController ### registered\_controllers - + ## Methods diff --git a/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.mdx b/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.mdx index bbefd1585cf..4b589969fea 100644 --- a/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.mdx +++ b/docs/api/qiskit/0.19/qiskit.validation.BaseSchema.mdx @@ -34,11 +34,11 @@ python_api_name: qiskit.validation.BaseSchema ### TYPE\_MAPPING - + ### dict\_class - + **Return type** `type` @@ -46,17 +46,17 @@ python_api_name: qiskit.validation.BaseSchema ### error\_messages - + Overrides for default schema-level error messages ### opts - + ### set\_class - + **Return type** `type` diff --git a/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.mdx b/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.mdx index 4128859e643..bd1bcfb4eec 100644 --- a/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.mdx +++ b/docs/api/qiskit/0.19/qiskit.validation.ModelTypeValidator.mdx @@ -25,7 +25,7 @@ python_api_name: qiskit.validation.ModelTypeValidator ### default\_error\_messages - + Default error messages for various kinds of errors. The keys in this dictionary are passed to Field.make\_error. The values are error messages passed to `marshmallow.exceptions.ValidationError`. @@ -35,19 +35,19 @@ python_api_name: qiskit.validation.ModelTypeValidator ### name - + ### parent - + ### root - + ### valid\_types - + ## Methods diff --git a/scripts/lib/api/generateApiComponents.ts b/scripts/lib/api/generateApiComponents.ts index d2bbdeef788..5c18d8a8f31 100644 --- a/scripts/lib/api/generateApiComponents.ts +++ b/scripts/lib/api/generateApiComponents.ts @@ -89,7 +89,7 @@ function prepareProps( const preparePropsPerApiType: Record ComponentProps> = { class: () => prepareClassProps($child, $dl, githubSourceLink, id), property: () => - preparePropertyProps($, $child, $dl, priorApiType, githubSourceLink, id), + prepareAttributeProps($, $child, $dl, priorApiType, githubSourceLink, id), method: () => prepareMethodProps($, $child, $dl, priorApiType, githubSourceLink, id), attribute: () => @@ -133,34 +133,6 @@ function prepareClassProps( return props; } -function preparePropertyProps( - $: CheerioAPI, - $child: Cheerio, - $dl: Cheerio, - priorApiType: string | undefined, - githubSourceLink: string | undefined, - id: string, -): ComponentProps { - const rawSignature = $child.find("em").text()?.replace(/^:\s+/, ""); - const props = { - id, - rawSignature, - githubSourceLink, - }; - - if (!priorApiType && id) { - $dl.siblings("h1").text(getLastPartFromFullIdentifier(id)); - return { - ...props, - isDedicatedPage: true, - }; - } - - $(`

${getLastPartFromFullIdentifier(id)}

`).insertBefore($dl); - - return props; -} - function prepareMethodProps( $: CheerioAPI, $child: Cheerio, @@ -197,20 +169,6 @@ function prepareAttributeProps( githubSourceLink: string | undefined, id: string, ): ComponentProps { - if (!priorApiType) { - if (id) { - $dl.siblings("h1").text(getLastPartFromFullIdentifier(id)); - } - const rawSignature = $child.find("em").text()?.replace(/^:\s+/, ""); - return { - id, - rawSignature, - githubSourceLink, - isDedicatedPage: true, - }; - } - - // Else, the attribute is embedded on the class const text = $child.text(); // Index of the default value of the attribute @@ -234,13 +192,25 @@ function prepareAttributeProps( .trim(); const attributeValue = text.slice(equalIndex + 1, text.length).trim(); - $(`

${name}

`).insertBefore($dl); - - return { + const props = { id, attributeTypeHint, attributeValue, + githubSourceLink, }; + + if (!priorApiType && id) { + $dl.siblings("h1").text(getLastPartFromFullIdentifier(id)); + return { + ...props, + isDedicatedPage: true, + }; + } + + // Else, the attribute is embedded on the class + $(`

${name}

`).insertBefore($dl); + + return props; } function prepareFunctionOrExceptionProps( diff --git a/scripts/lib/api/htmlToMd.test.ts b/scripts/lib/api/htmlToMd.test.ts index 0df0dbd4af8..a7c3a2a3942 100644 --- a/scripts/lib/api/htmlToMd.test.ts +++ b/scripts/lib/api/htmlToMd.test.ts @@ -731,7 +731,7 @@ for execution on present day noisy quantum systems.

"isReleaseNotes": false, "markdown": "# circuits - + Quantum circuits that represents quantum states. ", @@ -793,7 +793,7 @@ for execution on present day noisy quantum systems.

"isReleaseNotes": false, "markdown": "# callback - + ", "meta": { "apiName": "qiskit_ibm_runtime.options.EnvironmentOptions.callback",